Skip to content

Commit

Permalink
[fix] fix some readme and descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisvrose committed Jan 30, 2022
1 parent 3db167a commit 35435b4
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 6 deletions.
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
# xml-servicefile-parser

Parse `servicefile.xml` from stock Android pieces to create a script to restore to stock.
Parse `servicefile.xml`/`flashfile.xml` from stock Android pieces to create a script to restore to stock.

> Remember to *inspect* the created scripts before actually running them.

## NPM

### Usage



## Executable

### Building
Expand All @@ -15,7 +21,13 @@ Parse `servicefile.xml` from stock Android pieces to create a script to restore

### Usage

#### Option 1

1. Place alongside `servicefile.xml`.
2. Run executable.
2. Run executable. On Windows, double click. On Linux, do `chmod +x <filename>` then `./<filename>`
> Be aware that the default executable creates `serviceScript.sh` and `serviceScript.bat`, so don't have any files of that name already.
3. Inspect the scripts and use them as required.

#### Option 2

1. Run it passing the filename as the second argument
7 changes: 3 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
{
"name": "xml-servicefile-parser",
"version": "1.1.0",
"description": "Noob script to create scripts onn servicefile.xml",
"version": "1.1.1",
"description": "Create scripts on servicefile.xml for flashing images on Android Phones",
"bin": {
"main": "index.js"
},
"scripts": {
"test": "node .",
"pkg": "pkg . --out-path build/"
},
"prettier": {
Expand All @@ -18,7 +17,7 @@
"type": "git",
"url": "git+https://github.com/chrisvrose/xml-servicefile-parser.git"
},
"author": "Christopher Rose",
"author": "Atreya Bain",
"license": "MIT",
"bugs": {
"url": "https://github.com/chrisvrose/xml-servicefile-parser/issues"
Expand Down

0 comments on commit 35435b4

Please sign in to comment.