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
1710492dce
commit
409691e69c
1 changed files with 11 additions and 4 deletions
15
README.md
15
README.md
|
@ -32,10 +32,6 @@ Migration to open-source: ██░░░░░░░░░
|
|||
- [ ] Connector controls
|
||||
- [ ] Publish icons as separate importable package
|
||||
|
||||
## Want to contribute?
|
||||
|
||||
See [good first issues](https://github.com/markmanx/isoflow/contribute).
|
||||
|
||||
## Installation
|
||||
|
||||
Note: Isoflow is currently in development and _NOT_ production ready. To view it's current state of development:
|
||||
|
@ -85,6 +81,17 @@ const Isoflow = dynamic(() => import("isoflow"), {
|
|||
});
|
||||
```
|
||||
|
||||
## Development setup
|
||||
|
||||
1. Clone the repo
|
||||
2. `npm i`
|
||||
3. `npm run start`
|
||||
4. Visit `localhost:3000` in your browser
|
||||
|
||||
## Contributions
|
||||
|
||||
See [good first issues](https://github.com/markmanx/isoflow/contribute).
|
||||
|
||||
## License
|
||||
|
||||
Isoflow is MIT licensed (see ./LICENSE).
|
||||
|
|
Loading…
Reference in a new issue