Skip to content

Commit

Permalink
doc(core): improve a little bit the readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lorenzofox3 committed Mar 13, 2024
1 parent e32fc3f commit bc4b77a
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
6 changes: 6 additions & 0 deletions packages/core/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,15 @@

Core library to build web components from coroutines.

See the [blog article](https://lorenzofox.dev/posts/component-as-infinite-loop/) for more details.

## Installation

you can install the library with a package manager (like npm):
``npm install @cofn/core``

Or import it directly from a CDN

```js
import {define} from 'https://unpkg.com/@cofn/core/dist/cofn-core.js'
```
2 changes: 1 addition & 1 deletion readme.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# cofn

A set of small libraries to build your UI framework converting coroutines into web components
A set of small libraries to build your UI framework [converting coroutines into web components](https://lorenzofox.dev/posts/component-as-infinite-loop/).

* [core](./packages/core): define web components from a coroutine (666 bytes)
* [view](./packages/view): use declarative template rather than imperative rendering logic (1645 bytes)
Expand Down

0 comments on commit bc4b77a

Please sign in to comment.