Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
timvandam authored Jun 18, 2018
1 parent 6f9c4bf commit dec87ad
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,14 @@
# gemify
Turn your Steam items into gems.
# Gemify
Gemify is a CLI (Command Line Interface) application that allows you to easily convert your Steam items to Gems.

## Install
Gemify is built on top of [Node.JS] (https://nodejs.org/), make sure to install it before installing Gemify.

### Windows
To install Gemify on Windows you need to run the Install executable. Once installation has completed this window will automatically close. You can now run the Gemify executable to start using Gemify.

### Other Operating Systems
To install Gemify on operating systems other than Windows you will need to use the Terminal. Open your terminal and navigate to the folder in which you put the Gemify files. You can then run the `npm install` command to install Gemify. To use Gemify, use the command `node index`

#### Contact
If you need any help, feel free to contact me by [email](mailto:[email protected]) or on [Steam](https://steamcommunity.com/profiles/76561198340449674)

0 comments on commit dec87ad

Please sign in to comment.