mirror of
https://github.com/markmanx/isoflow.git
synced 2025-02-08 04:18:29 +00:00
chore: updates README
This commit is contained in:
parent
f1f9c0f92b
commit
255a8247d7
1 changed files with 25 additions and 2 deletions
27
README.md
27
README.md
|
@ -24,12 +24,35 @@ Migration to open-source: ██░░░░░░░░░
|
|||
|
||||
- [x] Set up automated publishing to NPM registry
|
||||
- [ ] Migrate private JS project to public Typescript project
|
||||
- [ ] Pan / Select / Zoom modes
|
||||
- [ ] Icons
|
||||
- [x] Pan / Select / Zoom modes
|
||||
- [x] Display icons in sidebar
|
||||
- [ ] Nodes
|
||||
- [ ] Groups
|
||||
- [ ] Connectors
|
||||
- [ ] Publish icons as separate importable package
|
||||
|
||||
## Installation
|
||||
|
||||
Note: Isoflow is currently not production ready. To view it's current state of development:
|
||||
|
||||
`npm install isoflow`
|
||||
|
||||
```
|
||||
import Isoflow from 'isoflow';
|
||||
|
||||
const App = () => (
|
||||
<Isoflow
|
||||
height={500}
|
||||
initialScene={{
|
||||
icons: [],
|
||||
nodes: [],
|
||||
connectors: [],
|
||||
groups: []
|
||||
}}
|
||||
>
|
||||
)
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
Isoflow is MIT licensed (see ./LICENSE).
|
||||
|
|
Loading…
Reference in a new issue