Skip to content

Commit

Permalink
doc: update features in README.md (#157)
Browse files Browse the repository at this point in the history
Fix #126.
  • Loading branch information
bfabio committed Nov 11, 2023
1 parent 838cf7b commit 4e561f4
Showing 1 changed file with 7 additions and 10 deletions.
17 changes: 7 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,20 +14,17 @@ This parser performs syntactic and semantic validation according to the

## Features

- Support for the Italian extension
- Check ISO 3166-1 alpha-2 and alpha-3 country codes
- Validate emails, URLs (http scheme, valid status code), local and remote files, dates as "YYYY-MM-DD", images (colors, mimes)
- Check pa-types
- Validate oembed video links and retrieve HTML for easy embedding
- Validate SPDX licenses. Without WITH keyword.
- Check tags
- Go library and CLI tool (`publiccode-parser`)
- Supports the latest version of the `publiccode.yml` Standard
- `publiccode-parser` can output validation errors as JSON or in [errorformat](https://vim-jp.org/vimdoc-en/quickfix.html#error-file-format) friendly way
- Verifies the existence of URLs by checking the response for URL fields (can be disabled)

## Example

```go
parser := publiccode.NewParser("file:///path/to/local/dir/publiccode.yml")
// OR
// parser := publiccode.NewParser("https://github.com/example/example//publiccode.yml")
// parser := publiccode.NewParser("https://github.com/example/example/publiccode.yml")

// all these settings are optional:
parser.DisableNetwork = true
Expand Down Expand Up @@ -126,7 +123,7 @@ This software is maintained by the

## License

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

Licensed under the EUPL.
Licensed under the EUPL 1.2.
The version control system provides attribution for specific lines of code.

0 comments on commit 4e561f4

Please sign in to comment.