Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Darius Musiolik committed Nov 9, 2018
1 parent 6b5b4d9 commit 1299ea0
Showing 1 changed file with 30 additions and 3 deletions.
33 changes: 30 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ If you wish to install my tool (not needed, it works perfectly without beeing in
# How to use it
First thing you have to do is to run the init: <br>
`$ sudo get-waterfox init` <br>
This will create the folder `/usr/share/waterfox`, you only have to execute it once. <br>
This will create the folders `/usr/share/waterfox` & `/usr/share/waterfox-data`, you only have to execute it once. <br>
<br>
Then you can download Waterfox from the official source: <br>
`$ get-waterfox download` <br>
Expand All @@ -19,7 +19,9 @@ After that, we are ready to install it: <br>

# Update Waterfox
If you wish to update your installed Waterfox, just run:<br>
`$ sudo get-waterfox update` <br>
`$ sudo get-waterfox update` <br><br>
If you only wish to check if there is an update for waterfox: <br>
`$ sudo get-waterfox checkupdate` <br>

# Cleanup your cache
If you wish to remove the cache copy of the Waterfox tarball in `/usr/share/waterfox`, just run:<br>
Expand All @@ -28,12 +30,37 @@ If you wish to remove the cache copy of the Waterfox tarball in `/usr/share/wate
# Remove Waterfox
If you wish to remove Waterfox, just run:<br>
`$ sudo get-waterfox remove` <br>
This will remove `/usr/share/waterfox` too. If you want to install Waterfox again, you need to execute `init` first. <br>
This will remove `/usr/share/waterfox` & `/usr/share/waterfox-data` too. If you want to install Waterfox again, you need to reexecute `init` first. <br>

# Remove this tool
If you wish to remove this tool, just run:<br>
`$ sudo ./get-waterfox-remove` <br>

# Flags
<table>
<tr>
<td>init</td> <td>-I</td>
</tr>
<tr>
<td>download</td> <td>-d</td>
</tr>
<tr>
<td>install</td> <td>-i</td>
</tr>
<tr>
<td>cleanup</td> <td>-C</td>
</tr>
<tr>
<td>checkupdate</td> <td>-c</td>
</tr>
<tr>
<td>version</td> <td>-v</td>
</tr>
<tr>
<td>remove</td> <td>-r</td>
</tr>
</table>

# Personal config
This tool will not touch any config file you got in `/home/youraccound/.waterfox`! <br>
Not even on `$ sudo get-waterfox remove` or `$ sudo ./get-waterfox-remove`.
Expand Down

0 comments on commit 1299ea0

Please sign in to comment.