docs: README reworked

* README reworked * Requested change made Co-authored-by: sct <sct@users.noreply.github.com> Co-authored-by: sct <sct@users.noreply.github.com>
4 years ago · 77f3f99fbb
parent e2b99b68e3
commit 77f3f99fbb
1 changed files with 19 additions and 19 deletions
--- a/README.md
+++ b/README.md
@ -16,34 +16,34 @@
 <a href="https://lgtm.com/projects/g/sct/overseerr/context:javascript"><img alt="Language grade: JavaScript" src="https://img.shields.io/lgtm/grade/javascript/g/sct/overseerr.svg?logo=lgtm&logoWidth=18"/></a>
 </p>

-**Overseerr** is a tool for managing requests for your media library. It integrates with existing services such as **Sonarr** and **Radarr**!
+**Overseerr** is a libre software tool for managing requests for your media library. It integrates with existing services such as **Sonarr** and **Radarr**!

 ## Current Features

 - Full Plex integration. Login and manage user access with Plex!
- Integrates easily with your existing services. Currently Overseerr supports Sonarr and Radarr. More in the future!
+- Integrates easily with your existing services. Currently Overseerr supports Sonarr and Radarr. More to come!
 - Syncs to your Plex library to know what titles you already have.
- Complex request system that allows users to request individual seasons or movies in a friendly, easy to use UI.
+- Complex request system allowing users to request individual seasons or movies in a friendly, easy to use UI.
 - Incredibly simple request management UI. Don't dig through the app to simply approve recent requests.
- Granular permissions system
+- Granular permission system
 - Mobile friendly design, for when you need to approve requests on the go!

 ## In Development

- User profiles
- User settings page to give users the ability to modify their Overseerr experience to their liking
- Version update notifications in-app
+- User profiles.
+- User settings page (to give users the ability to modify their Overseerr experience to their liking).
+- Version update notifications in-app.

 ## Planned Features

- More notification types (Slack/Telegram/etc)
+- More notification types (Slack/Telegram/etc.).
 - Issues system. This will allow users to report issues with content on your media server.
- Local user system (for those who do not use Plex)
- Compatiblity APIs to work with existing tools in your system
+- Local user system (for those who don't use Plex).
+- Compatiblity APIs (to work with existing tools in your system).

 ## Running Overseerr

-Currently, the only distribution of Overseerr is through Docker images. If you have Docker, you can run Overseerr with the following command:
+Currently, Overseerr is only distributed through Docker images. If you have Docker, you can run Overseerr as per:

 ```
 docker run -d \
@ -55,7 +55,7 @@ docker run -d \
  sctx/overseer
 ```

-After running Overseerr for the first time, visit the web UI at http://[address]:5055 and complete the setup steps to configure Overseerr.
+After running Overseerr for the first time, configure it by visiting the web UI at http://[address]:5055 and completing the setup steps.

 ⚠️ Overseerr is currently under very heavy, rapid development and things are likely to break often. We need all the help we can get to find bugs and get them fixed to hit a more stable release. If you would like to help test the bleeding edge, please use the image **sctx/overseerr:develop** instead! ⚠️

@ -65,33 +65,33 @@ After running Overseerr for the first time, visit the web UI at http://[address]

 ## Support

- You can reach us for support on [Discord](https://discord.gg/ySfaEUcQ).
- Bugs can be opened with an issue on [Github](https://github.com/sct/overseerr/issues).
+- You can get support on [Discord](https://discord.gg/ySfaEUcQ).
+- Bugs can be opened via a [GitHub issue](https://github.com/sct/overseerr/issues).

 ## API Documentation

-Full API documentation will soon be published automatically and available outside of running the app. But currently, you can access the api docs by running Overseerr locally and visiting http://localhost:3000/api-docs
+Full API documentation will soon be published automatically and available outside of running the app. Currently, you can access the API docs by running Overseerr locally and visiting http://localhost:3000/api-docs

 ## Contribution

-Anyone is welcome to contribute to Docker and pull requests are greatly appreciated! Contributors will be recognized in the future on this very README.
+Anyone is welcome to contribute to Docker, and pull requests are greatly appreciated! Contributors will get recognition in this README.

 ### Developing Overseerr

-You can develop Overseer entirely in docker. Make sure you have [Docker Desktop](https://www.docker.com/products/docker-desktop) installed before continuing.
+You can develop Overseer entirely in Docker. Make sure you have [Docker Desktop](https://www.docker.com/products/docker-desktop) installed before continuing.

 1. Make sure you have [Docker Desktop](https://www.docker.com/products/docker-desktop) installed.
 2. Run `docker-compose up -d` to start the server.
 3. Access the container at http://localhost:3000

-If Docker isn't your jam, you can always run Overseer with the following yarn commands:
+If Docker isn't your jam, you can always run Overseer with these Yarn commands:

 ```
 yarn
 yarn dev
 ```

-You will need NodeJS installed. Once it's built and running, access it locally at http://localhost:3000 just like Docker.
+You will need Node.js installed. Once it's built and running, access it locally at http://localhost:3000 (just like Docker).

 ### Translation