📝 Add more documentation and metadata

CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] - 2022-07-24
+
+- Initial release
+
+[1.0.0]: https://github.com/Pustur/genshin-impact-team-randomizer/releases/tag/1.0.0

README.md

@@ -1,3 +1,28 @@
 ## Genshin Impact Team Randomizer
 
 > A web app to randomize your Genshin Impact team based on the characters that you own
+
+## Usage
+
+Click on the character icons to select / remove them from the pool of selectable options.  
+The selection is stored in locally so you don't need to re-enter all your characters on subsequent visits.
+
+Once your roster is set, hit the "Generate teams" button.
+
+## Motivation
+
+I wanted to try Solid JS and this is the first idea that came to mind
+
+## Technologies used
+
+- Language: [TypeScript](https://www.typescriptlang.org/)
+- Library: [Solid JS](https://www.solidjs.com/)
+- Code formatting: [Prettier](https://prettier.io/)
+
+## Changelog
+
+[CHANGELOG](CHANGELOG.md)
+
+## License
+
+[MIT](LICENSE)

package.json

@@ -18,5 +18,17 @@
   },
   "dependencies": {
     "solid-js": "1.4.7"
-  }
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Pustur/genshin-impact-team-randomizer.git"
+  },
+  "author": {
+    "name": "Loris Bettazza",
+    "email": "loris.bettazza@gmail.com"
+  },
+  "bugs": {
+    "url": "https://github.com/Pustur/genshin-impact-team-randomizer/issues"
+  },
+  "homepage": "https://github.com/Pustur/genshin-impact-team-randomizer#readme"
 }