Commit 61404e10b46499a38012698fcbc6200b7830397d
Add readme
Charles Lehner committed on 5/14/2015, 7:36:48 PMParent: 77402cf1fed7ee86eb3be5c747df3e0429652d98
Files changed
README.md | added |
README.md | |||
---|---|---|---|
@@ -1,0 +1,27 @@ | |||
1 … | +# gitfeed | ||
2 … | + | ||
3 … | +Generate an [Atom](https://tools.ietf.org/html/rfc4287) feed from a git repo's | ||
4 … | +commit history. Each commit gets an entry in the feed showing its diff stat. | ||
5 … | + | ||
6 … | +## Usage | ||
7 … | + | ||
8 … | +First define some variables. The only required one is `SITE_URL` - the others | ||
9 … | +are optional. | ||
10 … | + | ||
11 … | + export SITE_TITLE='Example Site' | ||
12 … | + export SITE_URL='http://example.org' | ||
13 … | + export SITE_AUTHOR='Me' | ||
14 … | + export SITE_ENTRIES=30 # max number of entries in the feed | ||
15 … | + export SITE_WIDTH=100 # width of diff stat. leave at 80 unless you have | ||
16 … | + # long filenames. | ||
17 … | + | ||
18 … | +Then run the script to output the feed. | ||
19 … | + | ||
20 … | + ./feed.sh > ./feed.xml | ||
21 … | + | ||
22 … | +**gitfeed** is designed to work well with a Makefile. For example, see the | ||
23 … | +Makefile included in this project. | ||
24 … | + | ||
25 … | +# License | ||
26 … | + | ||
27 … | +MIT |
Built with git-ssb-web