diff options
| -rw-r--r-- | README.md | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..b719281 --- /dev/null +++ b/README.md @@ -0,0 +1,55 @@ +# Kodi Add-On for Newgrounds + +Video plugin for animations posted to Newgrounds. + +## Features + +- (Partial) support for the "Movies" section + - 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 + +Patches are welcome to [my email](https://jakob.space/pages/about.html). + +## Roadmap + +- [ ] Complete support for the "Movies" section + - [ ] Extraction of additional video metadata + - [ ] Search + - [ ] Support for collections + - [ ] Support for series +- [ ] Authentication + - [ ] Support for "Your Feed" +- [ ] Support for the "Audio" section +- [ ] Support for [Newgrounds Radio](https://www.newgrounds.com/radio) +- [ ] Support for the "Art" section + +## 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). |