Skip to content

Commit ecfcafd

Browse files
committed
docs: update README.md
1 parent 38d1b2f commit ecfcafd

1 file changed

Lines changed: 5 additions & 40 deletions

File tree

README.md

Lines changed: 5 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,11 @@
33
[![Join the #publiccode channel](https://img.shields.io/badge/Slack%20channel-%23publiccode-blue.svg?logo=slack)](https://developersitalia.slack.com/messages/CAM3F785T)
44
[![Get invited](https://slack.developers.italia.it/badge.svg)](https://slack.developers.italia.it/)
55

6-
This is a Go, web interface validator for [publiccode.yml](https://github.com/italia/publiccode.yml) files, using [publiccode-parser-go](https://github.com/italia/publiccode-parser-go).
6+
A RESTful API for validating [publiccode.yml](https://github.com/italia/publiccode.yml)
7+
files, using the [publiccode-parser-go](https://github.com/italia/publiccode-parser-go)
8+
library.
79

8-
publiccode.yml is an international standard for describing public software. It is expected to be published in the root of open source repositories. This parser performs syntactic and semantic validation according to the official spec.
9-
10-
## Features
11-
12-
See related project for details: [publiccode-parser-go](https://github.com/italia/publiccode-parser-go)
13-
14-
15-
## Validation from command line
16-
17-
The repository also contains a tool used to validate publiccode.yml files locally.
10+
## Usage
1811

1912
```bash
2013
go run main.go
@@ -24,40 +17,12 @@ curl -X POST "http://localhost:3000/v1/validate"
2417
--data-binary "@./publiccode.yml"
2518
```
2619

27-
## Docker support
28-
29-
The repository has a *Dockerfile*, used to also build the production image, and a *docker-compose.yml* file to facilitate the local deployment.
30-
31-
To build the container, run:
32-
33-
```shell
34-
docker-compose up [-d] [--build]
35-
```
36-
37-
where:
38-
39-
* *-d* execute the containers in background
40-
41-
* *--build* forces the containers build
42-
43-
To destroy the container, use:
44-
45-
```shell
46-
docker-compose down
47-
```
48-
49-
5020
## Contributing
5121

5222
Contributing is always appreciated.
5323
Feel free to open issues, fork or submit a Pull Request.
5424
If you want to know more about how to add new fields, check out [CONTRIBUTING.md](CONTRIBUTING.md). In order to support other country-specific extensions in addition to Italy some refactoring might be needed.
5525

56-
## See also
57-
58-
* [Developers Italia backend & crawler](https://github.com/italia/developers-italia-backend) - a Go crawler for PC.
59-
* [publiccode-parser-go](https://github.com/italia/publiccode-parser-go) - a Go parser and validator for publiccode.yml files.
60-
6126
## Maintainers
6227

6328
This software is maintained by community maintainers.
@@ -66,5 +31,5 @@ This software is maintained by community maintainers.
6631

6732
© 2018-2020 Team per la Trasformazione Digitale - Presidenza del Consiglio dei Minstri
6833

69-
Licensed under the EUPL.
34+
Licensed under AGPL-3.0.
7035
The version control system provides attribution for specific lines of code.

0 commit comments

Comments
 (0)