From d72f3256e98ef7afa8dcddb6b2c7000464b8c4f8 Mon Sep 17 00:00:00 2001 From: Starbeamrainbowlabs Date: Mon, 29 Jul 2019 19:49:58 +0100 Subject: [PATCH] Update README --- README.md | 33 ++++++++++++++++++++++++++++++++- 1 file changed, 32 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3db7815..813c7e3 100644 --- a/README.md +++ b/README.md @@ -2,4 +2,35 @@ > Create Atom feeds for websites that don't support it -Currently in alpha. +PolyFeed generates Atom feeds out of websites that don't have one, such as _Twitter_ or _Facebook_ (* cough * * cough *). It supports any platform that C♯ .NET applications can run, including Linux and Windows. + + +## Install + +### From a Release +Download and extract the [latest release](https://github.com/sbrl/PolyFeed/releases/latest). You're done! + +### Building from Source + +Clone this repository, and then build the code with `msbuild`: + +```bash +msbuild /p:Configuration=Release +``` + +The build output will be outputted to `PolyFeed/bin/Release`. + + +## Usage + + + + +## Contributing +Contributions are welcome - feel free to [open an issue](https://github.com/sbrl/PolyFeed/issues/new) or (even better) a [pull request](https://github.com/sbrl/PolyFeed/compare). + +The [issue tracker](https://github.com/sbrl/PolyFeed/issues) is the place where all the tasks relating to the project are kept. + + +## Licence +PolyFeed is released under the _Mozilla Public License 2.0_. The full license text is included in the `LICENSE` file in this repository.