Skip to content

Commit

Permalink
add badges
Browse files Browse the repository at this point in the history
  • Loading branch information
nichoth committed Nov 9, 2023
1 parent 9b7a02b commit 7e15d07
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,24 @@

A fork of [@socketsupply/tonic](https://github.com/socketsupply/tonic)

![tests](https://github.com/nichoth/tonic/actions/workflows/nodejs.yml/badge.svg)
[![Socket Badge](https://socket.dev/api/badge/npm/package/@nichoth/tonic)](https://socket.dev/npm/package/@nichoth/tonic)
[![module](https://img.shields.io/badge/module-ESM%2FCJS-blue)](README.md)
![license](https://img.shields.io/badge/license-MIT-brightgreen)


Tonic is a low profile component framework for the web. It's one file, less than 3kb gzipped and has no dependencies. It's designed to be used with modern Javascript and is compatible with all modern browsers and built on top of the Web Components.

## Installation

```sh
npm install @socketsupply/tonic
npm install @nichoth/tonic
```

## Usage

```js
import Tonic from '@socketsupply/tonic'
import Tonic from '@nichoth/tonic'

class MyGreeting extends Tonic {
render () {
Expand Down Expand Up @@ -53,6 +59,4 @@ After adding your Javascript to your HTML, you can use your component anywhere.
- [API](./API.md)
- [Troubleshooting](./HELP.md)

Copyright (c) 2023 Socket Supply Co.

MIT License

0 comments on commit 7e15d07

Please sign in to comment.