creamcrop

A cream-of-the-crop, top-of-the-top, slice-and-chop, absolutely minimalist news getter.

Usage no npm install needed!

<script type="module">
  import creamcrop from 'https://cdn.skypack.dev/creamcrop';
</script>

README

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 MIT license.

Documentation

Documentation is avaliable at creamcrop.js.org

Authors

Contributors ✨

Thank you to all contributors (emoji key):


QLabs
💻

This project follows the all-contributors specification. Contributions of any kind welcome!