[fix] fix some readme and descriptions

This commit is contained in:
2022-01-30 13:51:34 +05:30
parent 3db167a251
commit 35435b4aa6
2 changed files with 17 additions and 6 deletions

View File

@@ -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
@@ -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

View File

@@ -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": {
@@ -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"