From e059cf18a0e1181dcdfb8ffad3b6ea51ba923191 Mon Sep 17 00:00:00 2001 From: Federico Capoano Date: Sun, 4 Aug 2024 22:02:24 -0400 Subject: [PATCH] [docs] Back to Markdown README because of anible-galaxy --- README.md | 20 ++++++++++++++++++++ README.rst | 32 -------------------------------- 2 files changed, 20 insertions(+), 32 deletions(-) create mode 100644 README.md delete mode 100644 README.rst diff --git a/README.md b/README.md new file mode 100644 index 00000000..bf2a5307 --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +# ansible-openwisp2 + +[![Build Status](https://github.com/openwisp/ansible-openwisp2/workflows/Ansible%20OpenWISP2%20CI%20Build/badge.svg?branch=master)](https://github.com/openwisp/ansible-openwisp2/actions?query=workflow%3A%22Ansible+OpenWISP2+CI+Build%22) +[![Galaxy](http://img.shields.io/badge/galaxy-openwisp.openwisp2-blue.svg?style=flat-square)](https://galaxy.ansible.com/ui/standalone/roles/openwisp/openwisp2/) +[![Chat](https://img.shields.io/gitter/room/nwjs/nw.js.svg)](https://gitter.im/openwisp/general) + +Ansible role that installs the OpenWISP Server Application. + +Tested on **Debian (Bookworm/Bullseye)**, **Ubuntu (24/22/20 LTS)**. + +**Recommended minimum ansible core version**: 2.13. + +## Documentation + +- [Usage documentation](https://openwisp.io/docs/dev/ansible/) +- [Developer documentation](https://openwisp.io/docs/dev/ansible/developer/installation.html) + +## Support + +See [OpenWISP Support Channels](http://openwisp.org/support.html). diff --git a/README.rst b/README.rst deleted file mode 100644 index 4ebd4a38..00000000 --- a/README.rst +++ /dev/null @@ -1,32 +0,0 @@ -ansible-openwisp2 -================= - -.. image:: https://github.com/openwisp/ansible-openwisp2/workflows/Ansible%20OpenWISP2%20CI%20Build/badge.svg?branch=master - :target: https://github.com/openwisp/ansible-openwisp2/actions?query=workflow%3A%22Ansible+OpenWISP2+CI+Build%22 - :alt: Build Status - -.. image:: http://img.shields.io/badge/galaxy-openwisp.openwisp2-blue.svg?style=flat-square - :target: https://galaxy.ansible.com/ui/standalone/roles/openwisp/openwisp2/ - :alt: Galaxy - -.. image:: https://img.shields.io/gitter/room/nwjs/nw.js.svg - :target: https://gitter.im/openwisp/general - :alt: Chat - -Ansible role that installs the OpenWISP Server Application. - -Tested on **Debian (Bookworm/Bullseye)**, **Ubuntu (24/22/20 LTS)**. - -**Recommended minimum ansible core version**: 2.13. - -Documentation -------------- - -- `Usage documentation `_ -- `Developer documentation - `_ - -Support -------- - -See `OpenWISP Support Channels `__.