diff --git a/README.md b/README.md new file mode 100644 index 0000000..4cf969a --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +# [instances.invidio.us](https://instances.invidio.us) + +Status page for list of [Invidious](https://github.com/omarroth/invidious) instances, sourced from [here](https://github.com/omarroth/invidious/wiki/Invidious-Instances). + +## Installation + +```bash +$ git clone https://github.com/omarroth/instances.invidio.us +$ cd instances.invidio.us +$ shards install +$ crystal build src/instances.cr --release +``` + +## Usage + +```bash +$ ./instances -h + -b HOST, --bind HOST Host to bind (defaults to 0.0.0.0) + -p PORT, --port PORT Port to listen for connections (defaults to 3000) + -s, --ssl Enables SSL + --ssl-key-file FILE SSL key file + --ssl-cert-file FILE SSL certificate file + -h, --help Shows this help +``` + +## Contributing + +1. Fork it () +2. Create your feature branch (`git checkout -b my-new-feature`) +3. Commit your changes (`git commit -am 'Add some feature'`) +4. Push to the branch (`git push origin my-new-feature`) +5. Create a new Pull Request + +## Contributors + +- [Omar Roth](https://github.com/omarroth) - creator and maintainer