Skip to content
This repository has been archived by the owner on Jan 19, 2024. It is now read-only.

Update README #27

Open
kevinduffey opened this issue Jul 4, 2018 · 1 comment
Open

Update README #27

kevinduffey opened this issue Jul 4, 2018 · 1 comment

Comments

@kevinduffey
Copy link

Lets put some more content.. a lot more in the README. I dont have a good idea of what this project does, why you would use it, examples of how to use it, etc. The README is the place for this sort of stuff (or at least links to examples, etc). The current README leaves a lot to be desired as to the purpose and use of this project.

@alvin-milton
Copy link

Title: Generate a JavaScript API client from RAML

I installed it and ran it.

Here is what it did.

It appears to create a api client from your RAML file.

This api client is set up to be published to a repo and npm as a module.

Once thats done, you can npm i <your-module-name> --save into your project and use as a middleware.

I would agree, this could be spelled out for people just for illustration.

For example, I have further questions myself.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants