Skip to content

Commit

Permalink
Document new rss command
Browse files Browse the repository at this point in the history
  • Loading branch information
marvil07-adapt committed Nov 29, 2023
1 parent 9204bc8 commit f00be41
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,12 @@ This project tries to gather information about
[open source](https://opensource.org/osd) contributions for a given
organization.

## Producing an HTML file
## Producing output files

First, make sure you installed dependencies, e.g. `composer install`.

### HTML

There is some scripting in place to generate an `HTML` page based on the data.
It also contains `JSON-LD` output that may be useful if the page is public at
some point.
Expand All @@ -16,6 +18,14 @@ You may want to try the following command.

./contriblog html > contributions.html

### RSS

There is also a way to produce RSS output.

You may want to try the following command.

./contriblog rss > rss.xml

## Adding entries

- Use the helper, e.g. `./contriblog add`, or
Expand Down

0 comments on commit f00be41

Please sign in to comment.