docs: updated README and added product screenshots

ravgeetdhillon · Oct 17, 2021 · 2d20d24 · 2d20d24
1 parent 2e89193
commit 2d20d24
Show file tree

Hide file tree

Showing 7 changed files with 29 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,18 +1,45 @@
 [![CI](https://github.com/ravgeetdhillon/notion-feeder/actions/workflows/main.yml/badge.svg)](https://github.com/ravgeetdhillon/notion-feeder/actions/workflows/main.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 # Notion Feeder
 
 A Node.js app for creating a Feed Reader in [Notion](https://notion.so).
 
-## Prerequisites
+![](/screenshots/working.gif)
+
+## Features
+
+Separate database for your feed sources and feed items.
+
+![](/screenshots/image-1.png)
+
+Add, enable and disbale your feed sources.
+
+![](/screenshots/image-2.png)
+
+Feeds sourced daily and stored in Reader database. New feed items are marked with 🔥.
+
+![](/screenshots/image-3.png)
+
+Read a feed directly in Notion Page View.
+
+![](/screenshots/image-4.png)
+
+Different views of accessing Unread, Starred feed items.
+
+![](/screenshots/image-5.png)
+
+## Development
+
+### Prerequisites
 
 These things are required before setting up the project.
 
 - Git
 - Ubuntu 18.04 or 20.04
 - Node.js [Read Guide](https://www.digitalocean.com/community/tutorials/how-to-install-node-js-on-ubuntu-20-04)
 
-## Getting Started
+### Setup
 
 Follow these instructions to get the project up and running.
 

diff --git a/screenshots/image-1.png b/screenshots/image-1.png
diff --git a/screenshots/image-2.png b/screenshots/image-2.png
diff --git a/screenshots/image-3.png b/screenshots/image-3.png
diff --git a/screenshots/image-4.png b/screenshots/image-4.png
diff --git a/screenshots/image-5.png b/screenshots/image-5.png
diff --git a/screenshots/working.gif b/screenshots/working.gif