https://github.com/syncano/syncano-socket-readme-generator
https://github.com/syncano/syncano-socket-readme-generator
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/syncano/syncano-socket-readme-generator
- Owner: Syncano
- Created: 2018-01-31T15:06:41.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-03-19T13:53:29.000Z (about 7 years ago)
- Last Synced: 2024-03-25T03:22:33.799Z (about 1 year ago)
- Language: JavaScript
- Size: 49.8 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Syncano Socket Readme Generator
This CLI tool was created for Syncano Socket developers. It will let you generate a `README.md` file out of the Syncano `socket.yml` spec.
Currently, the supported `socket.yml` properties are:
- Config
- Classes
- Endpoints
And basic keys: name, description and version.
## Usage
```
npx s-readme socket.yml
```
The `README.md` file will be generated in the current working directory.
In case a `README.md` file already exists in the directory, the tool will ask to overwrite it.
## Tests
To run tests:
```
npm run test
```
or with watch:
```
npm run test:watch
```
End to end tests use a sample `test.yml` file located in `assets` folder to generate a markdown file for comparison. Use the `test.yml` as a reference point or create another one for e2e test variations.