Skip to content

Commit

Permalink
better docs
Browse files Browse the repository at this point in the history
  • Loading branch information
nichoth committed Jun 5, 2024
1 parent ed9acf8 commit ee834fd
Showing 1 changed file with 24 additions and 21 deletions.
45 changes: 24 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,27 +25,6 @@ Tonic is a low profile component framework for the web. It's one file, less than
npm install @bicycle-codes/tonic
```

## fork
This is a fork of [@socketsupply/tonic](https://github.com/socketsupply/tonic)

### additions
Things added to the forked version

#### `static get tag():string;`

Get the HTML tag name given a Tonic class.

```js
class ExampleTwo extends Tonic {
render () {
return this.html`<div>example two</div>`
}
}

ExampleTwo.tag
// => 'example-two'
```

## Use

```js
Expand Down Expand Up @@ -73,6 +52,30 @@ After adding your Javascript to your HTML, you can use your component anywhere.
</html>
```

## fork
This is a fork of [@socketsupply/tonic](https://github.com/socketsupply/tonic)

### additions
Things added to the forked version

#### `tag`
Get the HTML tag name given a Tonic class.

```ts
static get tag():string;
```

```js
class ExampleTwo extends Tonic {
render () {
return this.html`<div>example two</div>`
}
}

ExampleTwo.tag
// => 'example-two'
```

## Useful links
- [Tonic components](https://github.com/socketsupply/components)
- [Migration from the early versions of Tonic](./MIGRATION.md)
Expand Down

0 comments on commit ee834fd

Please sign in to comment.