Docs, branding

1 files changed, 41 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f2c843c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,41 @@
+# SRS Anywhere
+
+SRS Anywhere is a free, browser-based flash card application using the [Free Spaced Repetition Scheduler (FSRS)](https://github.com/open-spaced-repetition/free-spaced-repetition-scheduler) algorithm.
+It is similar to [Anki](https://en.wikipedia.org/wiki/Anki_(software)), except that it is entirely contained within static files and can therefore be used anywhere a web browser is available.
+No server is necessary.
+
+SRS Anywhere is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+SRS Anywhere is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
+You should have received a copy of the GNU Affero General Public License along with SRS Anywhere. If not, see <https://www.gnu.org/licenses/.>.
+
+## Usage
+
+Open `srs-anywhere.html` in a web browser and press the "Browse..." button in the top right-hand corner to load a deck of cards.
+The "?" button will display the available keyboard shortcuts.
+When the review is complete, you will be prompted to download a JSON file.
+This contains the deck of cards updated with new scheduling parameters for your next review.
+
+### Format for Cards
+
+The `cards.json` file is an array of objects containing at least the keys `id`, `front`, and `back`.
+The only requirement for `id` is that it's unique across the deck: it could be a UUID, but it could also be something more descriptive.
+`front` and `back` are HTML fragments that are injected into the page when the card is shown.
+Additional keys are permissible.
+Keys generated and modified by SRS Anywhere are prefixed by the `_` character.
+
+#### Example
+
+```json
+[
+  {
+    "id": "cca013c4-450a-41a1-abed-28abdc73413a",
+    "front": "What is the capital of Virginia?",
+    "back": "Richmond."
+  },
+  {
+    "id": "a8fc5101-2d22-4b20-b475-1db00f120654",
+    "front": "What is accomplished by Article II of the United States Constitution?",
+    "back": "Article II of the United States Constitution establishes the executive branch of the federal government, which carries out and enforces federal laws."
+  }
+]
+```