summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md32
1 files changed, 31 insertions, 1 deletions
diff --git a/README.md b/README.md
index 620c2f0..c992f3c 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,37 @@
# cable-club
+This is a weekend hack Rails app meant to be used by friends playing
+Pokémon games together. It provides a mechanism for checking out and
+checking in game save files, allowing multiple people to collaborate
+on the same "run" of game. There is also a simple Pokédex feature where
+players can record the Pokémon they catch in an run.
+It's very hacky and entirely untested. I haven't used it myself yet either
+since my friends and I ended up playing Pokémon hacks instead!
+
+The graphics in this project are being used purely as decoration in a free fan
+project. If you would like me to remove any of your work, please
+[email me](mailto:eapoems@riseup.net).
+
## Thanks
- Pokémon sprites from https://veekun.com/dex/downloads
-If you would like me to remove any of your work, please contact me.
+## License
+
+cable-club, a web app for playing Pokémon together
+
+Copyright (C) 2023 David Gay
+
+This program 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, version 3 of the License.
+
+This program 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 this program (the `LICENSE` file). If not, see
+<https://www.gnu.org/licenses/>.
+