Skip to content

Commit

Permalink
Add note about file structure
Browse files Browse the repository at this point in the history
  • Loading branch information
bitfl0wer committed Dec 27, 2023
1 parent f538d6c commit ecc80ba
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,8 @@
# polyproto
Specification documents and API documentation for the polyproto federated messaging protocol

## File structure

The `/docs` folder contains the specification documents for the polyproto protocol. The `docs/APIs` folder contains the API documentation for the polyproto-core and polyphony-chat reference implementation.

The `/snippets` folder contains snippets of text that are used in multiple places in the documentation. This is to ensure consistency across the documentation. Any error messages that are used in multiple places are also stored here, in the `/snippets/errors` folder.

0 comments on commit ecc80ba

Please sign in to comment.