From 5c274f5b0c7e35295dd79b7cfd514753b3e81d59 Mon Sep 17 00:00:00 2001 From: Anthony Lapenna Date: Tue, 12 May 2020 10:30:12 +1200 Subject: [PATCH] docs(readme): update README --- README.md | 24 +++++++++++------------- 1 file changed, 11 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 6149b69c3..4d5fe4230 100644 --- a/README.md +++ b/README.md @@ -3,15 +3,14 @@

[![Docker Pulls](https://img.shields.io/docker/pulls/portainer/portainer.svg)](https://hub.docker.com/r/portainer/portainer/) -[![Microbadger](https://images.microbadger.com/badges/image/portainer/portainer.svg)](http://microbadger.com/images/portainer/portainer "Image size") -[![Documentation Status](https://readthedocs.org/projects/portainer/badge/?version=stable)](http://portainer.readthedocs.io/en/stable/?badge=stable) +[![Microbadger](https://images.microbadger.com/badges/image/portainer/portainer.svg)](http://microbadger.com/images/portainer/portainer 'Image size') [![Build Status](https://portainer.visualstudio.com/Portainer%20CI/_apis/build/status/Portainer%20CI?branchName=develop)](https://portainer.visualstudio.com/Portainer%20CI/_build/latest?definitionId=3&branchName=develop) [![Code Climate](https://codeclimate.com/github/portainer/portainer/badges/gpa.svg)](https://codeclimate.com/github/portainer/portainer) [![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=YHXZJQNJQ36H6) **_Portainer_** is a lightweight management UI which allows you to **easily** manage your different Docker environments (Docker hosts or Swarm clusters). **_Portainer_** is meant to be as **simple** to deploy as it is to use. It consists of a single container that can run on any Docker engine (can be deployed as Linux container or a Windows native container, supports other platforms too). -**_Portainer_** allows you to manage all your Docker resources (containers, images, volumes, networks and more) ! It is compatible with the *standalone Docker* engine and with *Docker Swarm mode*. +**_Portainer_** allows you to manage all your Docker resources (containers, images, volumes, networks and more) ! It is compatible with the _standalone Docker_ engine and with _Docker Swarm mode_. ## Demo @@ -29,8 +28,8 @@ Unlike the public demo, the playground sessions are deleted after 4 hours. Apart ## Getting started -* [Deploy Portainer](https://portainer.readthedocs.io/en/latest/deployment.html) -* [Documentation](https://portainer.readthedocs.io) +- [Deploy Portainer](https://www.portainer.io/installation/) +- [Documentation](https://www.portainer.io/documentation/) ## Getting help @@ -38,19 +37,18 @@ For FORMAL Support, please purchase a support subscription from here: https://ww For community support: You can find more information about Portainer's community support framework policy here: https://www.portainer.io/2019/04/portainer-support-policy/ - -* Issues: https://github.com/portainer/portainer/issues -* FAQ: https://portainer.readthedocs.io/en/latest/faq.html -* Slack (chat): https://portainer.io/slack/ +- Issues: https://github.com/portainer/portainer/issues +- FAQ: https://www.portainer.io/documentation/faqs/ +- Slack (chat): https://portainer.io/slack/ ## Reporting bugs and contributing -* Want to report a bug or request a feature? Please open [an issue](https://github.com/portainer/portainer/issues/new). -* Want to help us build **_portainer_**? Follow our [contribution guidelines](https://portainer.readthedocs.io/en/latest/contribute.html) to build it locally and make a pull request. We need all the help we can get! +- Want to report a bug or request a feature? Please open [an issue](https://github.com/portainer/portainer/issues/new). +- Want to help us build **_portainer_**? Follow our [contribution guidelines](https://www.portainer.io/documentation/how-to-contribute/) to build it locally and make a pull request. We need all the help we can get! ## Security -* Here at Portainer, we believe in [responsible disclosure](https://en.wikipedia.org/wiki/Responsible_disclosure) of security issues. If you have found a security issue, please report it to . +- Here at Portainer, we believe in [responsible disclosure](https://en.wikipedia.org/wiki/Responsible_disclosure) of security issues. If you have found a security issue, please report it to . ## Limitations @@ -64,4 +62,4 @@ Portainer also contains the following code, which is licensed under the [MIT lic UI For Docker: Copyright (c) 2013-2016 Michael Crosby (crosbymichael.com), Kevan Ahlquist (kevanahlquist.com), Anthony Lapenna (portainer.io) -rdash-angular: Copyright (c) [2014] [Elliot Hesp] +rdash-angular: Copyright (c) [2014][elliot hesp]