From 737fd46e772237b7547262c374c5a0a6bb0750d5 Mon Sep 17 00:00:00 2001 From: CrimsonTome Date: Sun, 23 Oct 2022 19:54:15 +0100 Subject: [PATCH] chore: add repo scaffolding --- README.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/README.md b/README.md index f6866e6..1d69460 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,35 @@ # blog-to-cohost bot using cohost.py and feedparser to automate posting blog posts to cohost + +## System requirements + +- Linux (Windows may work but is not tested) +- Python +- Pip + +## Development + +- clone the repo +// more steps soon + +## Building + +### Python + +// steps here + +### Docker + +// steps here + +## Contributing + +// TODO Add contributing guidelines + +## License, Credits and Disclaimers + +blog-to-cohost is licensed under the MIT License. The full license text is included in the [LICENSE](LICENSE) file in this repository. Tldr legal have a [great summary](https://www.tldrlegal.com/l/mit) of the license if you're interested. + +This repo is built off the cohost.py, a library for cohost.org + +No part of this code is approved by cohost, this uses an **unofficial** API.