Skip to content

Commit

Permalink
Merge pull request #1 from patrickml/readme
Browse files Browse the repository at this point in the history
Create README.md
  • Loading branch information
patrickml authored Jul 29, 2016
2 parents 27d67fc + 368e3d2 commit 353c944
Showing 1 changed file with 61 additions and 0 deletions.
61 changes: 61 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# Pokélert
Pokélert is an Open Source Pokémon GO pokemon tracker. It uses the https://pokevision.com/ API to perform lookups. The Goal of this application is to provide background notifications of pokemon in your area. i.e Theres a Charazard 500m away!

## ToDo
- [ ] Finish Menu
- [ ] List Pokemon in menu and add filters
- [ ] List Pokemon in menu and toggle tracking
- [ ] Use pokemon API to pull up information about the pokemon when clicked
- [ ] Add Map Markers
- [ ] Add Background GeoLocation Services
- [ ] Notifiy use when pokemon they want are near
- [ ] Add local storage to store user filters and tracking

## Installation

To install this application you will need to have https://facebook.github.io/react-native/ installed you can follow there [getting started](https://facebook.github.io/react-native/docs/getting-started.html#content) guide.

## 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. Submit a pull request :D

## History

version 0.0.1

## Credits

@Patrickml
[@PokeVisionGO](https://twitter.com/pokevisiongo)

## License

```
The MIT License (MIT)
Copyright (c) 2016 Patrick Lewis
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```


0 comments on commit 353c944

Please sign in to comment.