Update README.md

This commit is contained in:
Mouse Reeve 2020-02-20 14:57:23 -08:00 committed by GitHub
parent a5d9001db0
commit f2e4a22ae4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -2,6 +2,17 @@
Social reading and reviewing, decentralized with ActivityPub
## Contents
- [The overall idea](#the-overall-idea)
- [What it is and isn't](#what-it-is-and-isnt)
- [The role of federation](#the-role-of-federation)
- [Features](#features)
- [Setting up the developer environment](#setting-up-the-developer-environment)
- [Structure](#structure)
- [Thoughts and considerations](#thoughts-and-considerations)
- [What even are books](#what-even-are-books)
- [Explain "review"](#explain-review)
## The overall idea
### What it is an isn't
FediReads is meant to be a platform for social reading; specifically, for tracking what you're reading and sharing your updates with friends, and reviewing and commenting on books. It isn't meant primarily for cataloguing or as a datasource for books, but it may incidentally act in that way even when that isn't the focus of the software. For example, listing books you've read can be a way for you to catalog their personal reading, even though the feature is designed with the intent of sharing updates on what you've read.