Skip to content

Commit

Permalink
readme tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
Twinki14 committed Sep 28, 2024
1 parent 1bf6e99 commit 1bbf831
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,12 @@ An OpenAPI (OAS) 3.1 specification implementation for the Satisfactory Server HT
## Getting started
Currently, you can find versions of the specification at https://github.com/satisfactory-oas/spec/releases

[Redocly documentation](https://redocly.com) is also available in the html file, `satisfactory-api-redoc.html` , which is included in current releases
## Documentation
You'll find `satisfactory-api-redoc.html` is included in current releases, which is generated using [Redocly](https://redocly.com), a popular OpenAPI spec documentation generator

- All currently known functions included
- Cleaner examples of how to format function requests
- Authentication scopes required for each request (wip)

## Plans
- Publishing the spec to GitHub Pages on an organization-level
Expand Down

0 comments on commit 1bbf831

Please sign in to comment.