Download as
Browse Code »

Commit a5ab7250eaa02aa5a6d25db134ca000bbdbe1a87

Authored by Rodrigo Siqueira de Melo
1 parent 0c140818
Exists in master and in 2 other branches packaging_status, refactor

Update README 

Closes #2
Showing 1 changed file with 33 additions and 13 deletions   Show diff stats
README.md
  Diff comments   View file @a5ab725
  1 +# COPR-STATUS
  2 +
  3 +----
  4 +
  5 +[![License](https://img.shields.io/badge/license-LGPLv3-green.svg)]("https://github.com/spb-tools/copr-status/COPYING")
  6 +[![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)
  7 +
  8 +----
  9 +
1 10 # About
2 11  
3   -This app was built to support the development of Portal do Software Público Brasileiro.
  12 +----
4 13  
5   -It shows versions for published packages in EPEL7 Fedora Copr repositories.
  14 +> This app was built to support the development of Portal do Software Público
  15 +Brasileiro. It shows versions for published packages in EPEL7 Fedora Copr
  16 +repositories. Note that this app consists of a single PSGI script, a template
  17 +file and Bootstrap.
6 18  
7   -Note that this app consists of a single PSGI script, a template file and Bootstrap.
  19 +----
  20 +# Development
8 21  
9   -# Instalation
  22 +> In order to use this app you will need perl 5 and the following perl modules
  23 +installed:
10 24  
11   -In order to use this app you will need perl 5 and the following perl modules installed:
  25 +* Plack
  26 +* LWP::UserAgent
  27 +* JSON
  28 +* Text::Template
12 29  
13   -Plack
14   -LWP::UserAgent
15   -JSON
16   -Text::Template
  30 +----
  31 +# How to use
17 32  
18   -# License
  33 +> If you want to use this app, you can simply using plackup as the command
  34 +below:
19 35  
20   -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.
  36 +```
  37 +plackup --port PORT_NUMBER APPLICATION.psgi
  38 +```
21 39  
22   -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.
  40 +> For example, try:
23 41  
24   -You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.
  42 +```
  43 +plackup --port 5001 spb_copr_status.psgi
  44 +```
... ...