Updated readme
This commit is contained in:
@@ -1,16 +1,41 @@
|
|||||||
# <img src="assets/rete.png" alt="drawing" width="21"/>ete, a basic URL checker.
|
# <img src="assets/rete.png" alt="drawing" width="21"/>ete, a basic URL checker.
|
||||||
|
|
||||||
## What is Rete?
|
## Usage
|
||||||
|
The basic usage to rete is `rete [arguments] [file/urls]`
|
||||||
|
there are a few flags you can use.
|
||||||
|
Example: `rete https://google.com https://fakeurl.bleb https://example.com`
|
||||||
|
|
||||||
|
### File flag
|
||||||
|
This flag allows you to check a list of urls in a txt file.
|
||||||
|
Example: `rete -f urls.txt`
|
||||||
|
#### Output flag
|
||||||
|
This flag lets you chose the name of the file outputted by the file flag.
|
||||||
|
Note: This flag but be used BEFORE the file flag is used
|
||||||
|
Example: `rete -o output.txt -f urls.txt`
|
||||||
|
|
||||||
|
### Timeout flag
|
||||||
|
This flag lets you chose how many seconds to wait for a connection until rete declares timeout.
|
||||||
|
Example: `rete -t 1 https://google.com https://fakeurl.bleb https://example.com`
|
||||||
|
|
||||||
|
## Compiling
|
||||||
|
Since this program was made with crystal, you need to install crystal and shards which is available in most package managers and windows.
|
||||||
|
|
||||||
|
### Installing dependencies
|
||||||
|
going into where the source code is and then run `shards install` which installs all of the dependencies.
|
||||||
|
|
||||||
|
### Creating the executable
|
||||||
|
To create the executable, run `shards build rete` where the binary will be in the bin directory.
|
||||||
|
|
||||||
|
## FAQ
|
||||||
|
|
||||||
|
### What is Rete?
|
||||||
Rete is a utility that can check if a URL/website is really up or not.
|
Rete is a utility that can check if a URL/website is really up or not.
|
||||||
|
|
||||||
## Whats the point of having it when I can check my self?
|
### Whats the point of having it when I can check my self?
|
||||||
Rete allows you to bulk check URLs which can be time saving.
|
Rete allows you to bulk check URLs which can be time saving.
|
||||||
|
|
||||||
## What about bot detection?
|
### What about bot detection?
|
||||||
Rete uses that to our advantage by looking at the status code (eg, a websites returns 403)
|
Rete uses that to our advantage by looking at the status code (eg, a websites returns 403)
|
||||||
|
|
||||||
## Why did you make this?
|
### Why did you make this?
|
||||||
When making a list of games and proxies, I needed to test if the links really worked without having to test them all individually (I had over 6000 links to check!)
|
When making a list of games and proxies, I needed to test if the links really worked without having to test them all individually (I had over 6000 links to check!)
|
||||||
|
|
||||||
## Creating an executable
|
|
||||||
First you must install all of the dependencies. You can install them quickly by running `pip install -r requirements.txt`. After that you can run pyinstaller, the python program that can create an executable from a python program. You can make the executable by running `pyinstaller main.py -F -n rete` This creates a single file executable named reta.
|
|
||||||
Reference in New Issue
Block a user