Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
simonbs authored Sep 20, 2024
1 parent 022e26f commit 3082c03
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ The repository contains the following files.

|File|Description|
|:-|:-|
|[openapi.yml](./blob/main/openapi.yml)|An OpenAPI specification that documents the API.|
|[.framna-docs.yml](./blob/main/.framna-docs.yml)|A configuration file that specifies the project name and icon to show on Framna Docs. For more information, see [the documentation of Framna Docs](https://github.com/shapehq/framna-docs/wiki/Adding-Documentation-to-Framna-Docs#customize-the-project).|
|[icon.png](blob/main/icon.png)|Thee icon displayed on Framna Docs.|
|[.spectral.yaml](./blob/main/.spectral.yaml)| A configuration file for the open-source [Spectral](https://stoplight.io/open-source/spectral) linter that can be used to validate the OpenAPI specification in [openapi.yml](./blob/main/openapi.yml).|
|[.github/workflows/lint.yml](./blob/main/.github/workflows/lint.yml)| A workflow that lints the OpenAPI specification in pull requests using the [Spectral](https://stoplight.io/open-source/spectral) linter.|
|[openapi.yml](./openapi.yml)|An OpenAPI specification that documents the API.|
|[.framna-docs.yml](./.framna-docs.yml)|A configuration file that specifies the project name and icon to show on Framna Docs. For more information, see [the documentation of Framna Docs](https://github.com/shapehq/framna-docs/wiki/Adding-Documentation-to-Framna-Docs#customize-the-project).|
|[icon.png](./icon.png)|Thee icon displayed on Framna Docs.|
|[.spectral.yaml](./.spectral.yaml)| A configuration file for the open-source [Spectral](https://stoplight.io/open-source/spectral) linter that can be used to validate the OpenAPI specification in [openapi.yml](./openapi.yml).|
|[.github/workflows/lint.yml](./.github/workflows/lint.yml)| A workflow that lints the OpenAPI specification in pull requests using the [Spectral](https://stoplight.io/open-source/spectral) linter.|

0 comments on commit 3082c03

Please sign in to comment.