diff --git a/README.md b/README.md index 44164e7..f106493 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ You can create config file with variables `server` and `proxy` in `~/.config/pbi Example contents: -``` +```ini server=https://paste.i2pd.xyz/ proxy=http://127.0.0.1:3128 ``` diff --git a/README.rst b/README.rst index f4daa75..34ee981 100644 --- a/README.rst +++ b/README.rst @@ -10,81 +10,74 @@ :alt: GitHub tag -.. image:: https://img.shields.io/github/release/r4sas/PBinCLI.svg - :target: https://github.com/r4sas/PBinCLI/releases/ - :alt: GitHub release +.. image:: https://api.codacy.com/project/badge/Grade/4f24f43356a84621bbd9078c4b3f1b70 + :target: https://www.codacy.com/app/r4sas/PBinCLI?utm_source=github.com&utm_medium=referral&utm_content=r4sas/PBinCLI&utm_campaign=Badge_Grade + :alt: Codacy Badge PBinCLI ======= -`PrivateBin `_ CLI -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +PBinCLI is command line client for `PrivateBin `_ written on Python 3. Installing ---------- .. code-block:: bash - $ virtualenv --python=python3 venv - $ . venv/bin/activate - $ pip install pbincli + virtualenv --python=python3 venv + . venv/bin/activate + pip install pbincli Usage ----- -By default pbincli configured to use https://paste.i2pd.xyz/ for sending and receiving pastes. No proxy used by default. +By default pbincli configured to use ``https://paste.i2pd.xyz/`` for sending and receiving pastes. No proxy used by default. You can create config file with variables ``server`` and ``proxy`` in ``~/.config/pbincli/pbincli.conf`` to use different settings. Example contents: -.. code-block:: +.. code-block:: ini server=https://paste.i2pd.xyz/ proxy=http://127.0.0.1:3128 Run inside ``venv`` command: -.. code-block:: - - $ pbincli send --text "Hello!" +.. code-block:: bash + pbincli send --text "Hello!" Or use stdin input to read text for paste: -.. code-block:: +.. code-block:: bash - $ pbincli send - <