Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation to reflect latest recommendations #649

Open
dustinmoris opened this issue Mar 4, 2024 · 1 comment
Open

Update documentation to reflect latest recommendations #649

dustinmoris opened this issue Mar 4, 2024 · 1 comment

Comments

@dustinmoris
Copy link

Hello, first of all thanks for open sourcing this project!

As I was searching through some older issues I came across this recommendation:

Our recommendation moving forward is to use Spectral's Node API and import our ruleset as a dependency to get consistent behavior with the CLI tool. That's what the CLI tool is doing behind the scenes.

To be honest this is the first time I have heard about Spectral and therefore it was not immediately clear to me how to hook this API validation ruleset up with the Spectral NPM package. I was wondering if you could provide a simple update to the current README to reflect your latest recommendation.

Many thanks :)

@dpopp07
Copy link
Member

dpopp07 commented Mar 15, 2024

Hello @dustinmoris - I'm glad the project looks beneficial to you!

That's a good suggestion. We'll look at adding that in the docs. In the meantime, we do have a quick guide in our README for the ruleset package itself. The way to hook it up is to install our ruleset (which is a standalone package), install Spectral separately, and write a Node program to utilize them together as in the linked example.

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

No branches or pull requests

2 participants