Skip to content

Commit 4ca84f5

Browse files
committed
fixed readme
1 parent 956f0a8 commit 4ca84f5

File tree

1 file changed

+18
-22
lines changed

1 file changed

+18
-22
lines changed

README.rst

+18-22
Original file line numberDiff line numberDiff line change
@@ -236,46 +236,42 @@ you can write your own collectors or/and checkers.
236236

237237
// TOOD: add more detailed readme about it
238238

239-
```
239+
.. code-block::
240240
241-
local/
242-
├── requirements.txt
243-
├── checkers
244-
│   └── custom_checker.py
245-
└── collectors
246-
   └── custom_collector.py
247-
248-
```
241+
local/
242+
├── requirements.txt
243+
├── checkers
244+
│   └── custom_checker.py
245+
└── collectors
246+
   └── custom_collector.py
249247
250248
You can create only checker or collector if you want so
251249

252250
2. Create `proxy_py/settings.py` in current dir with the following content
253251

254-
```python3
255-
256-
from ._settings import *
257-
from local.checkers.custom_checker import CustomChecker
252+
.. code-block:: python3
258253
259-
PROXY_CHECKERS = [CustomChecker]
254+
from ._settings import *
255+
from local.checkers.custom_checker import CustomChecker
260256
261-
COLLECTORS_DIRS = ['local/collectors']
257+
PROXY_CHECKERS = [CustomChecker]
262258
263-
```
259+
COLLECTORS_DIRS = ['local/collectors']
264260
265261
you can append your checker to PROXY_CHECKERS or COLLECTORS_DIRS instead of overriding to use built in ones as well, it's just normal python file.
266262
See `proxy_py/_settings.py` for more detailed instructions on options.
267263

268264
3. Follow the steps in "How to install?" but download this docker-compose config instead
269265

270-
```bash
271-
wget "https://raw.githubusercontent.com/DevAlone/proxy_py/master/docker-compose-with-local.yml"
272-
```
266+
.. code-block:: bash
267+
268+
wget "https://raw.githubusercontent.com/DevAlone/proxy_py/master/docker-compose-with-local.yml"
273269
274270
and run with command
275271

276-
```bash
277-
docker-compose -f docker-compose-with-local.yml up
278-
```
272+
.. code-block:: bash
273+
274+
docker-compose -f docker-compose-with-local.yml up
279275
280276
4. ...?
281277

0 commit comments

Comments
 (0)