diff options
-rw-r--r-- | README.rst | 96 |
1 files changed, 50 insertions, 46 deletions
diff --git a/README.rst b/README.rst index a7b75d6e2..c0008acde 100644 --- a/README.rst +++ b/README.rst @@ -1,63 +1,67 @@ -searx -===== - -A privacy-respecting, hackable `metasearch -engine <https://en.wikipedia.org/wiki/Metasearch_engine>`__. - -Pronunciation: səːks - -List of `running -instances <https://searx.space/>`__. - -See the `documentation <https://asciimoo.github.io/searx>`__ and the `wiki <https://github.com/asciimoo/searx/wiki>`__ for more information. - +.. SPDX-License-Identifier: AGPL-3.0-or-later + +.. figure:: https://raw.githubusercontent.com/asciimoo/searx/master/searx/static/themes/oscar/img/logo_searx_a.png + :target: https://asciimoo.github.io/searx/ + :alt: searX + :width: 100% + :align: center + +------- + +|searx install| +|searx homepage| +|searx wiki| +|AGPL License| +|Issues| +|commits| |OpenCollective searx backers| |OpenCollective searx sponsors| -Installation -~~~~~~~~~~~~ - -With Docker ------------ -Go to the `searx-docker <https://github.com/searx/searx-docker>`__ project. - -Without Docker --------------- -For all of the details, follow this `step by step installation <https://asciimoo.github.io/searx/admin/installation.html>`__. - -Note: the documentation needs to be updated. +Privacy-respecting, hackable `metasearch engine`_ / *pronunciation* **səːks**. -If you are in a hurry ---------------------- -- clone the source: - ``git clone https://github.com/asciimoo/searx.git && cd searx`` -- install dependencies: ``./manage.sh update_packages`` -- edit your - `settings.yml <https://github.com/asciimoo/searx/blob/master/searx/settings.yml>`__ - (set your ``secret_key``!) -- run ``python searx/webapp.py`` to start the application +.. _metasearch engine: https://en.wikipedia.org/wiki/Metasearch_engine +.. |searx install| image:: https://img.shields.io/badge/-install-blue + :target: https://asciimoo.github.io/searx/admin/installation.html -Bugs -~~~~ +.. |searx homepage| image:: https://img.shields.io/badge/-homepage-blue + :target: https://asciimoo.github.io/searx -Bugs or suggestions? Visit the `issue -tracker <https://github.com/asciimoo/searx/issues>`__. +.. |searx wiki| image:: https://img.shields.io/badge/-wiki-blue + :target: https://github.com/asciimoo/searx/wiki -`License <https://github.com/asciimoo/searx/blob/master/LICENSE>`__ -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.. |AGPL License| image:: https://img.shields.io/badge/license-AGPL-blue.svg + :target: https://github.com/asciimoo/searx/blob/master/LICENSE -More about searx -~~~~~~~~~~~~~~~~ +.. |Issues| image:: https://img.shields.io/github/issues/asciimoo/searx?color=yellow&label=issues + :target: https://github.com/asciimoo/searx/issues -- `openhub <https://www.openhub.net/p/searx/>`__ -- `twitter <https://twitter.com/Searx_engine>`__ -- IRC: #searx @ freenode +.. |PR| image:: https://img.shields.io/github/issues-pr-raw/asciimoo/searx?color=yellow&label=PR + :target: https://github.com/asciimoo/searx/pulls +.. |commits| image:: https://img.shields.io/github/commit-activity/y/asciimoo/searx?color=yellow&label=commits + :target: https://github.com/asciimoo/searx/commits/master .. |OpenCollective searx backers| image:: https://opencollective.com/searx/backers/badge.svg :target: https://opencollective.com/searx#backer - .. |OpenCollective searx sponsors| image:: https://opencollective.com/searx/sponsors/badge.svg :target: https://opencollective.com/searx#sponsor + + +If you are looking for running instances, ready to use, then visit searx.space_. + +Otherwise jump to the user_, admin_ and developer_ handbooks you will find on +our homepage_. + +.. _searx.space: https://searx.space +.. _user: https://asciimoo.github.io/searx/user +.. _admin: https://asciimoo.github.io/searx/admin +.. _developer: https://asciimoo.github.io/searx/dev +.. _homepage: https://asciimoo.github.io/searx + +contact: + openhub_ // twitter_ // IRC: #searx @ freenode + +.. _openhub: https://www.openhub.net/p/searx +.. _twitter: https://twitter.com/Searx_engine |