diff --git a/README.md b/README.md index 2241d35a..671cf027 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ * [Building the OAS file](#building-the-oas-file) - [Contributing](#contributing) * [Editing existing sources](#editing-existing-sources) - * [Adding a new sorce](#adding-a-new-sorce) + * [Adding a new source](#adding-a-new-source) * [Change existing models](#change-existing-models) - [Tests](#tests) - [Deployment](#deployment) @@ -125,7 +125,7 @@ Smaller edits such as spelling mistakes can be edited directly in Github. For la Game Content is stored in the `data` directory. It is first split according to which document/source books it originated from and further into JSON files split by category e.g. "monsters.json", "spells.json". These can be edited directly. You can also add new categories to existing sources by creating the required JSON file. See an existing source, such as the 5.1 SRD to see how these should be structured. -## Adding a new sorce +## Adding a new source To add a new source, create new directory inside `data` and a `document.json` file that credits the source and links to the license it was published under. An example of this can be found [here](/data/a5e_srd/document.json). You can then add a json file for each category of content. See an existing source, such as the 5.1 SRD to see how these should be structured. @@ -185,4 +185,4 @@ With docker installed, you can build the project with provided Dockerfile docker build ``` -This docker app can then be deployed with any provider. \ No newline at end of file +This docker app can then be deployed with any provider.