Add LICENSE + update README.md

.markdownlint.json

@@ -0,0 +1,13 @@
+{
+  "line-length": {
+    "line_length": 100,
+    "tables": false,
+    "code_blocks": false,
+    "headings": false
+  },
+  "no-inline-html": false,
+  "first-line-h1": false,
+  "no-trailing-punctuation": false,
+  "heading-increment": false,
+  "commands-show-output": false
+}

.prettierrc

@@ -0,0 +1,4 @@
+{
+  "printWidth": 100,
+  "proseWrap": "always"
+}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Chen Asraf
+
+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.

README.md

@@ -1,5 +1,32 @@
 # Gitignore File Generator
 
+GI Gen is an open source CLI to generate .gitignore files. It is completely cross-platform, and
+standalone (no dependencies).
+
 You can run this CLI program to create or append a .gitignore template easily.
 
+## Usage
+
+Download the file for your platform in the [Releases page][releases].
+
+Put it anywhere that you can run an executable from. It is completely portable to any directory, but
+it is preferable you put it somewhere that is in your `PATH`.
+
 Just run `gi_gen` in the directory you wish to add to and follow the prompts.
+
+```shell
+$ gi_gen
+```
+
+## Features
+
+GI Gen does the following things:
+
+- Discovers any gitignore templates that might be related to your project (optional)
+- Optionally clean up results from any patterns that aren't in your project
+- Writes to .gitignore (if a file already exists, you may append to it instead)
+
+Credits to [open-source-ideas][osi] for the idea for the app.
+
+[releases]: /releases/latest
+[osi]: https://github.com/open-source-ideas/ideas/issues/296