Skip to content

Commit 7a925a3

Browse files
committed
Add instructuons for oasdiff
1 parent 53a978d commit 7a925a3

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,17 @@ Please refer to the following articles in [the wiki](https://github.com/shapehq/
4141
- [Updating Documentation](https://github.com/shapehq/framna-docs/wiki/Updating-Documentation)
4242
- [Deploying Framna Docs](https://github.com/shapehq/framna-docs/wiki/Deploying-Framna-Docs)
4343

44+
### Install the OpenAPI diff tool locally
45+
46+
Framna Docs relies on the [`oasdiff`](https://github.com/oasdiff/oasdiff) CLI when comparing specifications.
47+
48+
On MacOS you can install with homebrew:
49+
50+
```bash
51+
brew tap oasdiff/homebrew-oasdiff
52+
brew install oasdiff
53+
```
54+
4455
## 👨‍🔧 How does it work?
4556

4657
Framna Docs uses [OpenAPI specifications](https://swagger.io) from GitHub repositories. Users log in with their GitHub account to access documentation for projects they have access to. A repository only needs an OpenAPI spec to be recognized by Framna Docs, but customization is possible with a .framna-docs.yml file. Here's an example:

0 commit comments

Comments
 (0)