A cream-of-the-crop, top-of-the-top, slice-and-chop, absolutely minimalist news getter
Installation
Install with npm/yarn:
npm i -g creamcrop
yarn global add creamcrop
Usage
Creamcrop can be used via the CLI with cream
or creamcrop
:
$ creamcrop --help
Usage: (creamcrop|cream) <command> [options]
Commands:
(creamcrop|cream) fetch [url] Fetch a feed.
(creamcrop|cream) serve [dir] Serves website from config file in [dir].
(creamcrop|cream) about Displays package info and exits.
Options:
--help Show help [boolean]
--version Show version number [boolean]
Contributing
You can start by setting up your clone:
git clone https://github.com/creamcropdev/creamcrop
cd creamcrop
npm install
npm link
Running Tests
To run tests, run the following command
npm test
Linting is also avaliable:
npm run lint
Appendix
License
The creamcrop project is licensed under the GPL-3.0 license.
Documentation
Documentation is avaliable at creamcrop.js.org
Authors
Contributors ✨
Thank you to all contributors (emoji key):
This project follows the all-contributors specification.
Contributions of any kind welcome!
v0.4.0
Adds:
- Improved Web Design
- Auto-update RSS feeds
- Custom port and host values for cream serve
- Add RSS sorting by date, independent of feed
- Add %pubdate%
option for format options
- Add %update%
option for website templates which get's replaced with an auto-update script