From 90cb89c390d245ca1ba74fa18e5537924cbefa8a Mon Sep 17 00:00:00 2001 From: julien-vidal Date: Sun, 7 Aug 2016 23:42:42 +0200 Subject: [PATCH] chore(readme) Add project purpose and what we plan to do --- README.md | 36 ++++++++++++++++++++++++++++-------- 1 file changed, 28 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 7f241dd..5dac169 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,51 @@ -# JsonSchemaToolkit +# Json Schema Toolkit +## Purpose + +Have a simple visualisation of a bundle of JSON schema. +Most of the time we have a Raw JSON which contains all schemas we need +for our app. But read a JSON file isn't easy and find relationships between +schema aren't so easy... + +## In progress + +The visualisation part, simply by pasting a json, you can search through all schema +for a specific one and check his attributes and links to others. + +## Future idea + +- Improve a lot the visualisation part +- Add a way to update schemas and create new one +- And so many... + +## Angular-cli generated documentation + This project was generated with [angular-cli](https://github.com/angular/angular-cli) version 1.0.0-beta.9. -## Development server +### Development server Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files. -## Code scaffolding +### Code scaffolding Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive/pipe/service/route/class`. -## Build +### Build Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `-prod` flag for a production build. -## Running unit tests +### Running unit tests Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io). -## Running end-to-end tests +### Running end-to-end tests Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/). Before running the tests make sure you are serving the app via `ng serve`. -## Deploying to Github Pages +### Deploying to Github Pages Run `ng github-pages:deploy` to deploy to Github Pages. -## Further help +### Further help To get more help on the `angular-cli` use `ng --help` or go check out the [Angular-CLI README](https://github.com/angular/angular-cli/blob/master/README.md).