Skip to content

Commit 586e7b0

Browse files
authored
Update README.md
1 parent c3d5d7a commit 586e7b0

File tree

1 file changed

+111
-2
lines changed

1 file changed

+111
-2
lines changed

README.md

+111-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
![alt text](https://gblobscdn.gitbook.com/assets%2F-MZTPzgUqGxiIf6m_uoa%2F-MdT8RECUAK42MnmqRTa%2F-MdT9crcWoeNiTkmhokB%2Fsniper-works.png)
2-
31
# Limit Sniper
42
A mempool sniping bot for Ethereum, Binance Smart Chain, Matic, & Fantom that is able to scan for new liquidity adds on token launches, so as to be able to buy a token as soon as liquidity is added --> in the same block
53

@@ -8,6 +6,117 @@ A mempool sniping bot for Ethereum, Binance Smart Chain, Matic, & Fantom tha
86
#### Grab the Latest Release:
97
https://github.com/CryptoGnome/Limit-Sniper/releases
108

9+
## HOW TO INSTALL Sniper Bot
10+
There are 3 ways to install Sniper Bot :
11+
12+
 
13+
14+
15+
### 1. Run The Python Code Locally [*this is most ideal and can work on any OS*]
16+
Here is a tutorial step-by-step:
17+
- [x] Download last Sniper Bot code on the "Code" page https://github.com/CryptoGnome/Limit-Sniper by clicking on Code > Download Zip:
18+
<img src="https://user-images.githubusercontent.com/70858574/145568534-e22c2887-d761-4fba-8dd0-f765b4300a6c.png" width="300">
19+
20+
- [x] Unzip file
21+
- [x] Install Python on your computer : https://www.python.org/downloads/
22+
23+
**PLEASE ADD IT TO PATH BY CHECKING THIS OPTION:**
24+
25+
<img src="https://user-images.githubusercontent.com/70858574/145692350-b2cb248a-8888-4471-8a63-2b6654e9b671.png" width="500">
26+
27+
- [x] Install Visual Studio : https://visualstudio.microsoft.com/fr/thank-you-downloading-visual-studio/?sku=Community&rel=17
28+
29+
Please install the default package and all those options :
30+
![image](https://user-images.githubusercontent.com/70858574/145580447-bd648d6d-c3ce-4dd9-8527-84ecfb5f30cc.png)
31+
32+
- [x] Open **Windows Powershell** (or Mac Terminal on MacOs)
33+
34+
- [X] Run this command to locate Sniper folder :
35+
36+
`Get-ChildItem -Filter sniper.py -Recurse -ErrorAction SilentlyContinue -Force`
37+
38+
- [x] It should look like this:
39+
40+
<img src="https://user-images.githubusercontent.com/70858574/145731245-21a90bd0-7d4d-43b0-b05d-8275bedd83b3.png" width="700">
41+
42+
- [X] Copy the Directory
43+
44+
(example : `C:\Users\Administrator\Desktop\Limit-Sniper-main`)
45+
46+
- [X] Paste the Directory after the "cd" command to navigate through the bot folder
47+
48+
(example : `cd C:\Users\Administrator\Desktop\Limit-Sniper-main`)
49+
50+
<img src="https://user-images.githubusercontent.com/70858574/145731342-1d707da4-084b-41cc-b714-2e987125e07e.png" width="700">
51+
52+
- [x] Run command: `pip install -r requirements.txt` --> this will install all the packages needed to run LimitSwap
53+
54+
&nbsp;
55+
56+
✅ ✅ ✅ And it's done! ✅ ✅ ✅
57+
58+
&nbsp;
59+
60+
- [x] Simply **double-click on "sniper.py"** and it will run, since you've installed Python 👍👍
61+
62+
&nbsp;
63+
64+
#### Pros and cons
65+
🟢 : you are sure of the code that is running on your computer
66+
67+
🔴 : little bit complicated
68+
69+
&nbsp;
70+
&nbsp;
71+
72+
### 2. Download the pre-compiled package [*This can lag behind current version*]
73+
That we provide on the Release page : it's a .exe file that you can run on your computer.
74+
https://github.com/CryptoGnome/Limit-Sniper/releases
75+
76+
#### Pros and cons
77+
🟢 : very easy to setup
78+
79+
🔴 : it's pre-compiled, so you cannot check the Source Code
80+
81+
&nbsp;
82+
&nbsp;
83+
84+
### 3. With Docker
85+
86+
#### Requirements
87+
MacOS and Windows users require Docker for Desktop https://www.docker.com/products/docker-desktop
88+
Ubuntu Linux require Docker installed `sudo apt-get install docker.io`
89+
90+
#### Usage
91+
Navigate into the bot directory and build the Docker image by executing the following command:
92+
93+
`docker build -t limit_sniper .`
94+
95+
(For MacOS and Linux) Still within the main directory you can run Docker via:
96+
97+
`docker run --rm --name limit-sniper -it -v $(pwd)/settings.json:/app/settings.json -v $(pwd)/tokens.json:/app/tokens.json limit_sniper`
98+
99+
(For Windows with Powershell)
100+
101+
`docker run --rm --name limit-sniper -it -v $PWD/settings.json:/app/settings.json -v $PWD/tokens.json:/app/tokens.json limit_sniper`
102+
103+
If you wish to run the container in the background please include -d for detached.
104+
105+
The streaming container logs can be visualised with `docker logs -f limit_sniper`
106+
107+
To stop the bot `docker stop limit_sniper`
108+
109+
#### Pros and cons
110+
🟢 : easy to setup if you know Docker
111+
112+
🔴 : needs Docker
113+
114+
&nbsp;
115+
116+
&nbsp;
117+
118+
![alt text](https://gblobscdn.gitbook.com/assets%2F-MZTPzgUqGxiIf6m_uoa%2F-MdT8RECUAK42MnmqRTa%2F-MdT9crcWoeNiTkmhokB%2Fsniper-works.png)
119+
11120

12121
## Developers 🔧
13122
Want to help contribute to LimitSwap, reach out on telegram all you need to do is make changes or fix bugs and we will pay developer bounties in $LIMIT for helping make the bot batter!

0 commit comments

Comments
 (0)