README

README.md

@@ -1,2 +1,41 @@
 # team-builder
 Inazuma Eleven Team Builder
+
+With this application you can form your own team consisting of Inazuma Eleven players.
+
+## Functionality
+Currently you can choose from all Inazuma Eleven 1, 2 and 3 players, including scout characters.
+GO (and maybe Ares/Orion) characters will be added soon.
+You can also add custom players. (Perfectly square images look the best)
+
+Before adding team members you can change the player names to English or Japanese names.
+You can also choose a formation, an emblem and a coach.
+
+When your team is complete you can export the team as an image and share it online.
+
+## Upcoming features
+* Right now the website only works well on pc and laptop screens. Mobile support will be added in the future.
+* Draggable player boxes
+* A more lively design
+* GO players & coaches and maybe Ares/Orion
+* More formations
+
+## Tech
+Inazuma Eleven Team Builder uses the following projects:
+* [jQuery](https://jquery.com/)
+* [Bootstrap](http://twitter.github.com/bootstrap/)
+* [Pinegrow](https://pinegrow.com/) - Front-end lay-out
+* [he](https://github.com/mathiasbynens/he/) - Encoding/decoding
+* [html2canvas](https://html2canvas.hertzen.com/) - Saving team as image
+* [ParseHub](https://www.parsehub.com/) - Scraping data
+
+## Data sources
+The following sources have been used for collecting data:
+* [Inazuma Eleven Wiki](https://inazuma-eleven.fandom.com) - Most extensive wiki of game players
+* [Inazuma Eleven Wiki (Spanish)](https://inazuma.fandom.com/es/) - Has a lot of sprites that the English wiki doesn't have
+* [watashiwa7](http://watashiwa7.altervista.org/) - Large database of most IE1, IE2 & IE3 players
+* [Kouryaku shimasu](http://kouryakusimasu.web.fc2.com/) - Complete database of IE1, IE2 & IE3 players
+* [Inazuma Eleven - Le Forum](https://inazumaeleven-forum.1fr1.net/t10521-index-des-noms) - Complete list of IE1, IE2 & IE3 players with nicknames
+* [TaleOfTheToaster](https://www.youtube.com/channel/UC653DWfy6x9JTXPlaDfkmlQ) - Useful gameplay with extensive showcases of dub (nick)names
+* [The Spriters Resource](https://www.spriters-resource.com/ds_dsi/inazumaeleven3sekaienochousensparkbombertheogre) - Complete sheets of IE1, IE2 and IE3 player sprites
+* [Inazuma Eleven Series](http://inazumaelevenseries.com) - Front-end design inspiration