Skip to content

Commit

Permalink
Updated readme to have better readability (#3569)
Browse files Browse the repository at this point in the history
* Made the READ me more read friendly and compactor.

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update faq.md
  • Loading branch information
nivong authored and elicwhite committed Aug 11, 2016
1 parent 350148e commit de09f34
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 27 deletions.
32 changes: 7 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,14 @@

# PokemonGo-Bot (Working)
# PokemonGo-Bot
PokemonGo bot is a project created by the [PokemonGoF](https://github.com/PokemonGoF) team.
The project is currently setup in two main branches. `dev` and `master`.

## Help Needed on [Desktop Version](https://github.com/PokemonGoF/PokemonGo-Bot-Desktop)

## Please submit PR to [Dev branch](https://github.com/PokemonGoF/PokemonGo-Bot/tree/dev)
The project is currently setup in two main branches. `dev` also known as `beta` and `master` also known as `stable`. Submit your PR's to `dev`.

We use [Slack](https://slack.com) as a web chat. [Click here to join the chat!](https://pokemongo-bot.herokuapp.com)
You can count on the community in #help channel.
If you need any help please don't create an issue here on github we have a great community on Slack, [Click here to join the chat!](https://pokemongo-bot.herokuapp.com). You can count on the community in #help channel.

## Table of Contents
- [Installation] (https://github.com/PokemonGoF/PokemonGo-Bot/blob/dev/docs/installation.md)
- [Features](#features)
- [Wiki](#wiki)
- [Wiki](https://github.com/PokemonGoF/PokemonGo-Bot/wiki)
- [Credits](#credits)

## Features
Expand All @@ -27,9 +23,9 @@ You can count on the community in #help channel.
- [x] Rudimentary IV Functionality filter
- [x] Ignore certain pokemon filter
- [x] Adjust delay between Pokemon capture & Transfer as per configuration
- [ ] Standalone Desktop Application
- [x] Hatch eggs
- [x] Incubate eggs
- [ ] [Standalone Desktop Application] (https://github.com/PokemonGoF/PokemonGo-Bot-Desktop)
- [ ] Use candy
- [ ] Inventory cleaner

Expand All @@ -45,22 +41,8 @@ If there are any concerns with this policy or you believe we are tracking someth

If you do not want any data to be gathered, you can turn off this feature by setting `health_record` to `false` in your `config.json`.

## Wiki
All information on [Getting Started](https://github.com/PokemonGoF/PokemonGo-Bot/wiki/Getting-Started) is available in the [Wiki](https://github.com/PokemonGoF/PokemonGo-Bot/wiki/)!
- __Installation__
- [Requirements] (https://github.com/PokemonGoF/PokemonGo-Bot/wiki/Installation#requirements-click-each-one-for-install-guide)
- [How to run with Docker](https://github.com/PokemonGoF/PokemonGo-Bot/wiki/How-to-run-with-Docker)
- [Linux] (https://github.com/PokemonGoF/PokemonGo-Bot/wiki/Installation#installation-linux)
- [Mac] (https://github.com/PokemonGoF/PokemonGo-Bot/wiki/Installation#installation-mac)
- [Windows] (https://github.com/PokemonGoF/PokemonGo-Bot/wiki/Installation#installation-windows)
- [Develop PokemonGo-Bot](https://github.com/PokemonGoF/PokemonGo-Bot/wiki/Develop-PokemonGo-Bot)
- [Plugins](https://github.com/PokemonGoF/PokemonGo-Bot/blob/dev/docs/plugins.md)
- [Configuration-files](https://github.com/PokemonGoF/PokemonGo-Bot/wiki/Configuration-files)
- [Front end web module - Google Maps API] (https://github.com/PokemonGoF/PokemonGo-Bot/wiki/Google-Maps-API-(web-page))
- [Docker Usage](https://github.com/PokemonGoF/PokemonGo-Bot/wiki/FAQ#how-to-run-with-docker)
- [FAQ](https://github.com/PokemonGoF/PokemonGo-Bot/wiki/FAQ)
## Help Needed on [Desktop Version](https://github.com/PokemonGoF/PokemonGo-Bot-Desktop)

To ensure that all updates are documented - [@eggins](https://github.com/eggins) will keep the Wiki updated with the latest information on installing, updating and configuring the bot.

## Credits
- [tejado](https://github.com/tejado) many thanks for the API
Expand Down
9 changes: 7 additions & 2 deletions docs/faq.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
### How do I start the application?
After customizing your config.json files, cd to the PokemonGo-Bot folder and enter:
After [installing] (https://github.com/PokemonGoF/PokemonGo-Bot/blob/dev/docs/installation.md), in the root folder run the following command:
### Linux
```
$ python pokecli.py
run.sh
```
### Windows
```
run.bat
```
This will start the application.

Expand Down

0 comments on commit de09f34

Please sign in to comment.