Fix command descriptions in README.md

This commit is contained in:
Stone_Red
2022-04-25 11:14:27 +02:00
parent c2b84dd475
commit 826c6fc7ee
+2 -11
View File
@@ -25,7 +25,6 @@ You can generate `.hyper` files with your client using the [generate](https://gi
These files contain the hash value of the actual file and the hosts that should have the requested file. These files contain the hash value of the actual file and the hosts that should have the requested file.
You can use the [get from](https://github.com/Stone-Red-Code/HyperbolicDownloader#getfrom) command to retrieve the file or if you are using Windows you can right-click the `.hyper` file, select `open with` and select the HyperbolicDownloader executable. You can use the [get from](https://github.com/Stone-Red-Code/HyperbolicDownloader#getfrom) command to retrieve the file or if you are using Windows you can right-click the `.hyper` file, select `open with` and select the HyperbolicDownloader executable.
## Disclaimer ## Disclaimer
Keep in mind that all network traffic is not encrypted. So, do not send sensitive information with HyperbolicDownloader. Keep in mind that all network traffic is not encrypted. So, do not send sensitive information with HyperbolicDownloader.
@@ -41,31 +40,26 @@ Since none of the files are stored anywhere centralized, the quality of the file
**Description:** Exits the application.\ **Description:** Exits the application.\
**Parameter:** `none` **Parameter:** `none`
### `clear` | `cls` ### `clear` | `cls`
**Description:** Clears the console.\ **Description:** Clears the console.\
**Parameter:** `none` **Parameter:** `none`
### `info` | `inf` ### `info` | `inf`
**Description:** Displays the private and public IP address.\ **Description:** Displays the private and public IP address.\
**Parameter:** `none` **Parameter:** `none`
### `discover` | `disc` ### `discover` | `disc`
**Description:** Tries to find other active hosts on the local network.\ **Description:** Tries to find other active hosts on the local network.\
**parameter:** `none` **parameter:** `none`
### `check` | `status` ### `check` | `status`
**Description:** Checks the status of known hosts.\ **Description:** Checks the status of known hosts.\
**parameter:** `none` **parameter:** `none`
### `list` | `ls` ### `list` | `ls`
**Description:** Lists all files\ **Description:** Lists all files\
@@ -73,15 +67,14 @@ Since none of the files are stored anywhere centralized, the quality of the file
#### `<list> files` #### `<list> files`
**Description:** Lists all files\ **Description:** Lists all files.\
**parameter:** `none` **parameter:** `none`
#### `<list> hosts` #### `<list> hosts`
**description:** lists all hosts **description:** Lists all hosts.\
**parameter:** `none` **parameter:** `none`
### `add` ### `add`
**Description:** Adds a file to the tracking list.\ **Description:** Adds a file to the tracking list.\
@@ -97,7 +90,6 @@ Since none of the files are stored anywhere centralized, the quality of the file
**Description:** Adds a host to the list of known hosts.\ **Description:** Adds a host to the list of known hosts.\
**parameter:** `<IpAddress:port>` **parameter:** `<IpAddress:port>`
### `remove` | `rm` ### `remove` | `rm`
**Description:** Removes a file from the tracking list.\ **Description:** Removes a file from the tracking list.\
@@ -113,7 +105,6 @@ Since none of the files are stored anywhere centralized, the quality of the file
**Description:** Removes a host from the list of known hosts.\ **Description:** Removes a host from the list of known hosts.\
**parameter:** `<IpAddress:Port>` **parameter:** `<IpAddress:Port>`
### `get` ### `get`
**Description:** Attempts to retrieve a file from another host using a hash.\ **Description:** Attempts to retrieve a file from another host using a hash.\