Skip to content

Commit 367869a

Browse files
author
Jordan Potter
committed
Update README
1 parent 7b0f9e2 commit 367869a

File tree

1 file changed

+35
-2
lines changed

1 file changed

+35
-2
lines changed

README.md

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,38 @@
1-
# DaggerSearch Data
1+
# Daggerheart Data
22

3-
### Darrington Press Community Gaming License
3+
This repository provides JSON game data and schema definitions for the [Daggerheart System Reference Document (SRD)](https://www.daggerheart.com/srd/). Use these files to build custom websites, bots, tools, and more for our favorite TTRPG!
4+
5+
For example, this data powers [daggersearch.com](https://daggersearch.com)
6+
7+
## Darrington Press Community Gaming License
48

59
This product includes materials from the Daggerheart System Reference Document 1.0, © Critical Role, LLC. under the terms of the Darrington Press Community Gaming (DPCGL) License. More information can be found at https://www.daggerheart.com. There are no previous modifications by others.
10+
11+
## Structure
12+
13+
Releases have their own directory (e.g. `core`) that contains JSON files for ancestries, communities, subclasses, domain cards, etc.
14+
15+
The `_schemas` directory contains JSON schemas that validate the JSON files in release directories.
16+
17+
## Contributing
18+
19+
[Create a fork](https://github.com/daggersearch/daggerheart-data/fork) of this repository, then clone your fork and install dependencies:
20+
21+
```bash
22+
git clone https://github.com/YOUR-USERNAME/daggerheart-data.git
23+
cd daggerheart-data
24+
npm install
25+
```
26+
27+
After making any changes, format and validate by running:
28+
29+
```bash
30+
npm run format
31+
npm run validate
32+
```
33+
34+
When you're done, push your changes and open a pull request!
35+
36+
## Support
37+
38+
For questions or issues, please [open an issue](https://github.com/daggersearch/daggerheart-data/issues) on GitHub.

0 commit comments

Comments
 (0)