summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJakob L. Kreuze <zerodaysfordays@sdf.org>2024-07-14 14:37:42 -0400
committerJakob L. Kreuze <zerodaysfordays@sdf.org>2024-07-14 14:37:42 -0400
commit78b78ce781e06f27235b59809518b0d612fc3bc7 (patch)
treed68dd632e1023be9c211ddd13c3f51859284b9d1 /README.md
Initial commit
Diffstat (limited to 'README.md')
-rw-r--r--README.md46
1 files changed, 46 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ac52bf7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,46 @@
+# Kodi Add-On for Newgrounds
+
+Audio plugin for songs posted to Newgrounds.
+
+## Features
+
+- Navigating by Featured/Latest/Popular
+- Navigating by category
+
+## Versions Supported
+
+- Kodi Media Center 21.0
+
+## Installation
+
+Clone this repository to the `addons` directory in your Kodi configuration directory (typically `~/.kodi/`).
+
+## Contributing
+
+Please send patches to me [via email](https://jakob.space/pages/about.html).
+
+## Roadmap
+
+- [ ] Support for "Your Feed"
+- [ ] Support for other audio types (voice and podcasts)
+
+## License
+
+This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+
+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 General Public License](LICENSE.txt) for more details.
+
+### Artifacts
+
+The following files are _not_ licensed under the GPL:
+
+- `resources/icon.png`
+- `resources/fanart.jpg`
+
+`resources/icon.png` is the Newgrounds Tankman logo.
+I believe that its use here for identification purposes qualifies as fair use under the Copyright law of the United States.
+
+`resources/fanart.jpg` is ["Pico Day 2021 Banner"](https://www.newgrounds.com/art/view/slyvern/pico-day-2021-banner) by cynicallysly.
+It was released under [CC BY 3.0](https://creativecommons.org/licenses/by/3.0/deed.en).