diff --git a/README.md b/README.md index 72e8e36d..07b1f006 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,9 @@ +

+ + Vigilant logo + +

+ # Vigilant [![Latest Version](https://img.shields.io/github/release/VerifiedJoseph/vigilant.svg?style=flat-square)](https://github.com/VerifiedJoseph/vigilant/releases/latest) @@ -5,16 +11,21 @@ Vigilant is a PHP script for monitoring RSS/ATOM and JSON feeds, and sending push notifications on new entries. -Vigilant supports sending push notifications with [Gotify](https://gotify.net) or [ntfy.sh](https://ntfy.sh). +Supports sending push notifications with [Gotify](https://gotify.net) or [ntfy.sh](https://ntfy.sh). + +Vigilant can either be run manually or in a Docker container, making it quick and easy to deploy. ## Documentation -- [Installation](docs/install.md) -- [Configuration](docs/configuration.md) -- [Feeds File](docs/feeds.md) +- 📥[Installation](docs/install.md) +- ⚙️[Configuration](docs/configuration.md) +- 📝[Feeds File](docs/feeds.md) ## Requirements +🐳Docker + +Or for manual setup: - PHP >= 8.2 - Composer - PHP Extensions: @@ -38,4 +49,4 @@ All notable changes to this project are documented in the [CHANGELOG](CHANGELOG. ## License -MIT License. Please see [LICENSE](LICENSE) for more information. +MIT License. Please see [LICENSE](https://github.com/VerifiedJoseph/vigilant/blob/main/LICENSE) for more information. diff --git a/docs/.nojekyll b/docs/.nojekyll new file mode 100644 index 00000000..e69de29b diff --git a/docs/README.md b/docs/README.md new file mode 120000 index 00000000..32d46ee8 --- /dev/null +++ b/docs/README.md @@ -0,0 +1 @@ +../README.md \ No newline at end of file diff --git a/docs/_404.md b/docs/_404.md new file mode 100644 index 00000000..55cd84ca --- /dev/null +++ b/docs/_404.md @@ -0,0 +1 @@ +

404 - Not found

\ No newline at end of file diff --git a/docs/_coverpage.md b/docs/_coverpage.md new file mode 100644 index 00000000..4b1b616e --- /dev/null +++ b/docs/_coverpage.md @@ -0,0 +1,15 @@ +![logo](_media/logo/vigilant-icon.svg) + +# Vigilant + +[![Latest Version](https://img.shields.io/github/release/VerifiedJoseph/vigilant.svg?style=flat-square)](https://github.com/VerifiedJoseph/vigilant/releases/latest) +[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE) + +> An RSS/ATOM/JSON feed monitor with push notifications + +- Simple and lightweight +- Push notifications with [Gotify](https://gotify.net) or [ntfy.sh](https://ntfy.sh) +- Deploy as a Docker container + +[Get Started](README.md) +[↗️ GitHub](https://github.com/VerifiedJoseph/vigilant/) diff --git a/docs/_media/logo/vigilant-icon.svg b/docs/_media/logo/vigilant-icon.svg new file mode 100644 index 00000000..00f98e1d --- /dev/null +++ b/docs/_media/logo/vigilant-icon.svg @@ -0,0 +1,47 @@ + + + + diff --git a/docs/_media/logo/vigilant.png b/docs/_media/logo/vigilant.png new file mode 100644 index 00000000..d1a44e5b Binary files /dev/null and b/docs/_media/logo/vigilant.png differ diff --git a/docs/_media/logo/vigilant.svg b/docs/_media/logo/vigilant.svg new file mode 100644 index 00000000..951fa975 --- /dev/null +++ b/docs/_media/logo/vigilant.svg @@ -0,0 +1,47 @@ + + + + diff --git a/docs/_sidebar.md b/docs/_sidebar.md new file mode 100644 index 00000000..c8b2a809 --- /dev/null +++ b/docs/_sidebar.md @@ -0,0 +1,6 @@ +* [Vigilant](README.md) +* [📥Installation](install.md) +* [⚙️Configuration](configuration.md) +* [📝Feeds File](feeds.md) +* [🗓️Changelog](CHANGELOG.md) +* [↗️ GitHub](https://github.com/VerifiedJoseph/vigilant/) diff --git a/docs/docsify.md b/docs/docsify.md new file mode 100644 index 00000000..059706df --- /dev/null +++ b/docs/docsify.md @@ -0,0 +1,20 @@ +

+ + Docsify logo + +

+ +# Documentation powered by Docsify + +### Follow the Docsify '[Quick start](https://docsify.js.org/#/quickstart)' guide on how to install and run it locally. + +1. Install Docsify `npm i docsify-cli -g`. + +2. At root of the repo `docsify serve docs`. + +3. Set `basePath: '/',` in `index.html` for localhost website, revert when finished. + + +### Read the Docsify '[Deploy](https://docsify.js.org/#/deploy)' guide on how to deploy the documentation to GitHub Pages. + +- Select `main branch /docs folder` as your GitHub Pages source. \ No newline at end of file diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 00000000..3d815277 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,44 @@ + + + + + + Vigilant + + + + + + + + + + +
+ + + + + + + + + + + +