Commit aec18c960c4aa8a02c95617175b8a67e715fb95d
Update README
Anders Rune Jensen committed on 1/4/2018, 11:57:32 PMParent: c32f22a9c00c9cc0b9543a315e5e30e5245c7989
Files changed
README.md | changed |
README.md | |||
---|---|---|---|
@@ -1,23 +1,26 @@ | |||
1 | -# Bookclub - a module for storing information about books | ||
1 … | +# Patchbook | ||
2 | 2 … | ||
3 … | +A book rating system for | ||
4 … | +[patchcore](https://github.com/ssbc/patchcore) compatible [scuttlebutt](https://github.com/ssbc/secure-scuttlebutt) clients | ||
5 … | + | ||
3 | 6 … | ## Attributes: | |
4 | 7 … | ||
5 | 8 … | common: | |
6 | 9 … | - title | |
7 | 10 … | - authors | |
8 | 11 … | - description | |
9 | 12 … | - series | |
10 | -- [images] | ||
13 … | +- seriesNo | ||
14 … | +- image | ||
11 | 15 … | ||
12 | 16 … | subjective: | |
13 | -(- user (implied)) | ||
14 | 17 … | - rating | |
15 | -- rating type | ||
16 | -(- read (datetime)) | ||
18 … | +- ratingMax | ||
19 … | +- ratingType | ||
17 | 20 … | - review | |
18 | 21 … | - shelve | |
19 | -- categories/genres | ||
22 … | +- genre | ||
20 | 23 … | ||
21 | 24 … | If we seperate common from user attributes, we can just merge common | |
22 | 25 … | into a global object. User related (subjective) should infer the user | |
23 | 26 … | from who posted it and merge into a list. |
Built with git-ssb-web