diff --git a/README.md b/README.md index d290753..f6ac6ce 100644 --- a/README.md +++ b/README.md @@ -27,31 +27,53 @@ Slixfeed is primarily designed for XMPP (aka Jabber), yet it is built to be exte ### monocles chat -Chat: Add URL -Ad-Hoc: Commands +Chat: Add URL +Ad-Hoc: Commands - + ### Cheogram -Ad-Hoc: Add URL -Ad-Hoc: Settings +Ad-Hoc: Add URL +Ad-Hoc: Settings - + ## Getting Started ### Install -It is possible to install Slixfeed using pip inside venv. +It is possible to install Slixfeed using pip and pipx. + +#### pip inside venv ``` $ python3 -m venv .venv $ source .venv/bin/activate $ pip install git+https://gitgud.io/sjehuda/slixfeed +``` + +#### pipx + +##### Install + +``` +$ pipx install git+https://gitgud.io/sjehuda/slixfeed +``` + +##### Upgrade + +``` +$ pipx install --upgrade slixfeed +``` + +#### Start + +``` $ slixfeed ``` + ### Usage - Add the bot to contact list and follow it instructions. diff --git a/pyproject.toml b/pyproject.toml index f3e62d4..c1d495e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -86,9 +86,3 @@ platforms = ["any"] [tool.setuptools.package-data] "*" = ["*.ini", "*.csv", "*.toml", "*.svg"] - -[tool.setuptools.packages.find] -where = ["."] -include = ["slixfeed"] -exclude = [] -namespaces = false diff --git a/screenshots/adhoc_add_url.png b/slixfeed/documentation/screenshots/adhoc_add_url.png similarity index 100% rename from screenshots/adhoc_add_url.png rename to slixfeed/documentation/screenshots/adhoc_add_url.png diff --git a/screenshots/adhoc_commands.png b/slixfeed/documentation/screenshots/adhoc_commands.png similarity index 100% rename from screenshots/adhoc_commands.png rename to slixfeed/documentation/screenshots/adhoc_commands.png diff --git a/screenshots/adhoc_settings.png b/slixfeed/documentation/screenshots/adhoc_settings.png similarity index 100% rename from screenshots/adhoc_settings.png rename to slixfeed/documentation/screenshots/adhoc_settings.png diff --git a/screenshots/chat_add_url.png b/slixfeed/documentation/screenshots/chat_add_url.png similarity index 100% rename from screenshots/chat_add_url.png rename to slixfeed/documentation/screenshots/chat_add_url.png