mirror of
https://github.com/sbrl/PolyFeed.git
synced 2024-12-24 10:45:02 +00:00
Update README
This commit is contained in:
parent
5f3d1f824d
commit
d72f3256e9
1 changed files with 32 additions and 1 deletions
33
README.md
33
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.
|
||||
|
|
Loading…
Reference in a new issue