diff --git a/README.md b/README.md index 4e8268c..2cdf8a9 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,20 @@ +# ssn-tools + This repository contains command line tools for handling patches. It uses the functions exposed by the [ssn](/swtor/ssn) library and makes them available for use on the shell. -# Installation +## Installation -For this tool to work, the TypeScript compiler must be globally installed: +Run the following commands in your Linux shell: ```bash +# Install TypeScript globally sudo npm install -g typescript -``` -Install dependencies and transpile the TypeScript files to JavaScript by running: +# Download repository +git clone https://git.jedipedia.net/swtor/ssn-tools.git +cd ssn-tools -```bash +# Install dependencies and transpile TypeScript files to JavaScript npm install && npm start ``` @@ -22,7 +26,7 @@ alias swtor_install='node /path/to/installation/ssn-tools/dist/installPatch.js' complete -W 'assets_swtor_de_de assets_swtor_en_us assets_swtor_fr_fr assets_swtor_main assets_swtor_test_de_de assets_swtor_test_en_us assets_swtor_test_fr_fr assets_swtor_test_main eualas movies_de_de movies_en_us movies_fr_fr patcher2014 patcher2017 retailclient_liveqatest retailclient_swtor retailclient_publictest' 'swtor_install' ``` -# Usage +## Usage ```bash dist/getManifest.js --product assets_swtor_main @@ -32,7 +36,7 @@ dist/installPatch.js assets_swtor_main 126 127 swtor_install assets_swtor_main 126 127 ``` -# License +## License Copyright (C) 2018 Jedipedia.net