Merge pull request #14 from m-triassi/12-readme

Add a README to the project

CONTRIBUTING.md

@@ -0,0 +1,37 @@
+# Contributing
+
+Contributions are **welcome** and will be fully **credited**.
+
+Please read and understand the contribution guide before creating an issue or pull request.
+
+## Etiquette
+
+This project is open source, and as such, the maintainers give their free time to build and maintain the source code
+held within. They make the code freely available in the hope that it will be of use to other developers. It would be
+extremely unfair for them to suffer abuse or anger for their hard work.
+
+Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the
+world that developers are civilized and selfless people.
+
+It's the duty of the maintainer to ensure that all submissions to the project are of sufficient
+quality to benefit the project. Many developers have different skillsets, strengths, and weaknesses. Respect the maintainer's decision, and do not be upset or abusive if your submission is not used.
+
+## Viability
+
+When requesting or submitting new features, first consider whether it might be useful to others. Open
+source projects are used by many developers, who may have entirely different needs to your own. Think about
+whether or not your feature is likely to be used by other users of the project.
+
+## Procedure
+
+Before filing an issue:
+
+- Attempt to replicate the problem, to ensure that it wasn't a coincidental incident.
+- Check to make sure your feature suggestion isn't already present within the project.
+- Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
+- Check the pull requests tab to ensure that the feature isn't already in progress.
+
+Before submitting a pull request:
+
+- Check the codebase to ensure that your feature doesn't already exist.
+- Check the pull requests to ensure that another person hasn't already submitted the feature or fix.

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Plank Multimedia
+
+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

@@ -0,0 +1,65 @@
+# WoWForge-CLI
+
+WoWForge-CLI is an simple command line utility for Linux that can be used to track and install addons for World of Warcraft from CurseForge. It's extremely simplistic and lightweight requiring very little setup or external dependencies.
+
+## Installation
+Currently pre-built binaries are available for download in the repositories [releases](https://github.com/m-triassi/wowforge-cli/releases) page. Simply download a release and follow the guidance below.
+
+First ensure that the downloaded binary is executable:
+```bash
+sudo chmod +x /path/to/wowforge-cli 
+```
+
+Then, simply move the built application to any folder in your `PATH`, like `/usr/local/bin` or `/home/MYUSER/.local/bin` depending on your system, and personal setup.
+
+Alternatively you can make a new directory somewhere and append that directory to your `PATH`, like so:
+
+```bash
+mkdir /my/custom/path
+mv ~/Downloads/wowforge-cli /my/custom/path
+echo "export PATH=\"$PATH:/my/custom/path\"" >> ~/.bashrc
+source ~/.bashrc
+```
+
+Finally you can also just keep the binary in a specific file and specify the full path to it when ever you want to use it, like so: `./my/path/to/wowforge-cli <command>`
+
+### Set up
+Before being able to use application you **must** set the install path configuration value. This path specifies where 
+to install addons to. If you are using Lutris or Wine this path should be mounted somewhere in your file system. 
+
+With Lutris specifically you can right-click on the game and press "Browse Files" and it should open a file browser in 
+the root of the wine environment. 
+
+Make sure to get the path all the way down to the `.../interface/addons` directory. 
+Once you've found the path use the `set` command to set the path:
+
+```bash
+wowforge-cli set --install "/path/to/Games/battlenet/drive_c/Program Files (x86)/World of Warcraft/_retail_/Interface/AddOns/"
+```
+
+## Usage
+Once `wowforge-cli` is installed and set up you can simply track new addons with the `add` command, and update them with the `update` command.
+
+### Adding a Addon
+To add an addon you will need the "project id" of the addon. Thankfully this ID is easy to find and is listed under "Project ID" 
+in the description of each addon, under the "About Project" heading on the right-hand side. With this ID in hand you can simply run:
+
+```bash
+wowforge-cli add <ID>
+```
+
+This will download and install the addon to the path you specified above, as well as save the ID for future updates
+
+### Updating Addons
+Updating addons is even easier, since all tracked ID are saved, you running the `update` command will update all tracked addons one by one without any intervention.
+```bash
+wowforge-cli update
+```
+
+## Contributing
+
+Please see [CONTRIBUTING](https://github.com/m-triassi/wowforge-cli/blob/main/CONTRIBUTING.md) for details.
+
+## License
+
+The MIT License (MIT). Please see [License File](https://github.com/m-triassi/wowforge-cli/blob/main/LICENSE.md) for more information.