| commit | 0b611d6900835f30013a9a671970146170136fd2 | [log] [tgz] |
|---|---|---|
| author | Peter K. Lee <peter@corenova.com> | Thu Jul 28 19:01:02 2016 -0700 |
| committer | GitHub <noreply@github.com> | Thu Jul 28 19:01:02 2016 -0700 |
| tree | f7395e7186911ed150de2e2cad699ecb27e188c4 | |
| parent | e8d9867300854310a22edae01533b4c59e442515 [diff] |
Update README.md
YANG model-driven CORD
This is a work-in-progress effort to create YANG data models for the CORD project and deliver flexible service compositions.
You may contact Larry Peterson llp@onlab.us and Peter Lee peter@corenova.com to learn more about this initiative and find out how you can help.
$ npm install yang-cord
Following the installation, you can start an instance of the YANG model-driven REST API web server. It utilizes yang-express middleware framework built on Express.js to provide dynamic YANG model-driven API routing capability.
$ npm start > yang-cord@1.0.1 start /home/peter/yang-cord > node lib/server.js mounted 'cord-core' model mounted 'xos-core' model [cord-core] calling GET on /cord-core:subscriber
For more information on interacting with the REST API endpoints, please refer to the API Overview documentation found in the ./doc folder.
For more information on current YANG models for XOS and CORD, please refer to the Model Overview documentation found in the ./schema folder.
For more information on controller logic and dynamic interfaces, please refer to the Source Overview documentation found in the ./src folder.
To run the test suite, first install the dependencies, then run npm test:
$ npm install $ npm test
Mocha test suite is currently under development...