From a5ab7250eaa02aa5a6d25db134ca000bbdbe1a87 Mon Sep 17 00:00:00 2001 From: rodrigosiqueira Date: Mon, 2 Nov 2015 23:00:25 -0200 Subject: [PATCH] Update README --- README.md | 46 +++++++++++++++++++++++++++++++++------------- 1 file changed, 33 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 0b47e55..4d115cc 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,44 @@ +# COPR-STATUS + +---- + +[![License](https://img.shields.io/badge/license-LGPLv3-green.svg)]("https://github.com/spb-tools/copr-status/COPYING") +[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/spb-tools/copr-status?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) + +---- + # About -This app was built to support the development of Portal do Software Público Brasileiro. +---- -It shows versions for published packages in EPEL7 Fedora Copr repositories. +> This app was built to support the development of Portal do Software Público +Brasileiro. It shows versions for published packages in EPEL7 Fedora Copr +repositories. Note that this app consists of a single PSGI script, a template +file and Bootstrap. -Note that this app consists of a single PSGI script, a template file and Bootstrap. +---- +# Development -# Instalation +> In order to use this app you will need perl 5 and the following perl modules +installed: -In order to use this app you will need perl 5 and the following perl modules installed: +* Plack +* LWP::UserAgent +* JSON +* Text::Template -Plack -LWP::UserAgent -JSON -Text::Template +---- +# How to use -# License +> If you want to use this app, you can simply using plackup as the command +below: -This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. +``` +plackup --port PORT_NUMBER APPLICATION.psgi +``` -This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +> For example, try: -You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/. +``` +plackup --port 5001 spb_copr_status.psgi +``` -- libgit2 0.21.2