@@ -1,63 +1,73 @@
1−searx
2−=====
1+.. SPDX-License-Identifier: AGPL-3.0-or-later
2+
3+.. figure:: https://raw.githubusercontent.com/asciimoo/searx/master/searx/static/themes/oscar/img/logo_searx_a.png
4+ :target: https://asciimoo.github.io/searx/
5+ :alt: searX
6+ :width: 100%
7+ :align: center
8+
9+-------
10+
11+|searx install|
12+|searx homepage|
13+|searx wiki|
14+|AGPL License|
15+|Issues|
16+|commits|
17+|OpenCollective searx backers|
18+|OpenCollective searx sponsors|
319
4−A privacy-respecting, hackable `metasearch
5−engine <https://en.wikipedia.org/wiki/Metasearch_engine>`__.
20+Privacy-respecting, hackable `metasearch engine`_ / *pronunciation* **səːks**.
621
7−Pronunciation: səːks
22+.. _metasearch engine: https://en.wikipedia.org/wiki/Metasearch_engine
823
9−List of `running
10−instances <https://searx.space/>`__.
24+.. |searx install| image:: https://img.shields.io/badge/-install-blue
25+ :target: https://asciimoo.github.io/searx/admin/installation.html
1126
12−See the `documentation <https://asciimoo.github.io/searx>`__ and the `wiki <https://github.com/asciimoo/searx/wiki>`__ for more information.
27+.. |searx homepage| image:: https://img.shields.io/badge/-homepage-blue
28+ :target: https://asciimoo.github.io/searx
1329
14−|OpenCollective searx backers|
15−|OpenCollective searx sponsors|
30+.. |searx wiki| image:: https://img.shields.io/badge/-wiki-blue
31+ :target: https://github.com/asciimoo/searx/wiki
1632
17−Installation
18−~~~~~~~~~~~~
33+.. |AGPL License| image:: https://img.shields.io/badge/license-AGPL-blue.svg
34+ :target: https://github.com/asciimoo/searx/blob/master/LICENSE
1935
20−With Docker
21−-----------
22−Go to the `searx-docker <https://github.com/searx/searx-docker>`__ project.
36+.. |Issues| image:: https://img.shields.io/github/issues/asciimoo/searx?color=yellow&label=issues
37+ :target: https://github.com/asciimoo/searx/issues
2338
24−Without Docker
25−--------------
26−For all of the details, follow this `step by step installation <https://asciimoo.github.io/searx/admin/installation.html>`__.
39+.. |PR| image:: https://img.shields.io/github/issues-pr-raw/asciimoo/searx?color=yellow&label=PR
40+ :target: https://github.com/asciimoo/searx/pulls
2741
28−Note: the documentation needs to be updated.
42+.. |commits| image:: https://img.shields.io/github/commit-activity/y/asciimoo/searx?color=yellow&label=commits
43+ :target: https://github.com/asciimoo/searx/commits/master
2944
30−If you are in a hurry
31−---------------------
32−- clone the source:
33− ``git clone https://github.com/asciimoo/searx.git && cd searx``
34−- install dependencies: ``./manage.sh update_packages``
35−- edit your
36− `settings.yml <https://github.com/asciimoo/searx/blob/master/searx/settings.yml>`__
37− (set your ``secret_key``!)
38−- run ``python searx/webapp.py`` to start the application
45+.. |OpenCollective searx backers| image:: https://opencollective.com/searx/backers/badge.svg
46+ :target: https://opencollective.com/searx#backer
3947
48+.. |OpenCollective searx sponsors| image:: https://opencollective.com/searx/sponsors/badge.svg
49+ :target: https://opencollective.com/searx#sponsor
4050
41−Bugs
42−~~~~
4351
44−Bugs or suggestions? Visit the `issue
45−tracker <https://github.com/asciimoo/searx/issues>`__.
52+If you are looking for running instances, ready to use, then visit searx.space_.
4653
47−`License <https://github.com/asciimoo/searx/blob/master/LICENSE>`__
48−~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
54+Otherwise jump to the user_, admin_ and developer_ handbooks you will find on
55+our homepage_.
4956
50−More about searx
51−~~~~~~~~~~~~~~~~
57+.. _searx.space: https://searx.space
58+.. _user: https://asciimoo.github.io/searx/user
59+.. _admin: https://asciimoo.github.io/searx/admin
60+.. _developer: https://asciimoo.github.io/searx/dev
61+.. _homepage: https://asciimoo.github.io/searx
5262
53−- `openhub <https://www.openhub.net/p/searx/>`__
54−- `twitter <https://twitter.com/Searx_engine>`__
55−- IRC: #searx @ freenode
63+contact:
64+ openhub_ // twitter_ // IRC: #searx @ freenode
5665
66+.. _openhub: https://www.openhub.net/p/searx
67+.. _twitter: https://twitter.com/Searx_engine
5768
58−.. |OpenCollective searx backers| image:: https://opencollective.com/searx/backers/badge.svg
59− :target: https://opencollective.com/searx#backer
69+-------
6070
71+|gluten free|
6172
62−.. |OpenCollective searx sponsors| image:: https://opencollective.com/searx/sponsors/badge.svg
63− :target: https://opencollective.com/searx#sponsor
73+.. |gluten free| image:: https://forthebadge.com/images/featured/featured-gluten-free.svg