Skip to content

Commit

Permalink
Added README
Browse files Browse the repository at this point in the history
  • Loading branch information
taras committed Aug 23, 2018
1 parent 66a012f commit c2908a5
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 2 deletions.
34 changes: 34 additions & 0 deletions README.md
@@ -1,3 +1,37 @@
[![Coverage Status](https://coveralls.io/repos/github/microstates/todomvc/badge.svg?branch=tm%2Fupgrade-microstates)](https://coveralls.io/github/microstates/todomvc?branch=tm%2Fupgrade-microstates)

# TodoMVC Microstate

This package provides a Microstate model for state of a TodoMVC component. It includes tests and is published as `@microstates/todomvc` package. The purpose of this package is to show how a Microstate can be distributed via NPM. The state can be consumed by projects in different frameworks.

Learn more about Microstates.js at [microstates/microstates.js](http://github.com/microstates/todomvc).

## Installation

`npm install --save @microstates/todomvc`

or

`yarn add @microstates/todomvc`

## Getting Started

To use this model, you can import it and create a Microstate.

```js
import { create } from 'microstates'
import TodoMVC from '@microstate/todomvc'

let todomvc = create(TodoMVC)
```

## Tests

The Microstate comes with [tests](tests/todomvc-test.js) with 100% coverage.

```js
git clone git@github.com:microstates/todomvc.git
cd todomvc
npm install
npm test
```
4 changes: 2 additions & 2 deletions package.json
@@ -1,6 +1,6 @@
{
"name": "microstates-todomvc",
"version": "1.0.0-beta.18",
"name": "@microstates/todomvc",
"version": "1.0.0-beta.0",
"description": "Microstate for TodoMVC Components",
"main": "build/todomvc.cjs.js",
"module": "build/todomvc.es.js",
Expand Down

0 comments on commit c2908a5

Please sign in to comment.