From 6c6e2798e0cb64e05ca2af3b8428d15b82946fdf Mon Sep 17 00:00:00 2001
From: Giuseppe Pascale <14334976+pasc4le@users.noreply.github.com>
Date: Sat, 4 Dec 2021 01:34:50 +0100
Subject: [PATCH] :memo: Creating a README

---
 README.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d48e3a2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+# Notion Pretty-Print
+This is a simple tool to pretty-print your Notion notes with custom styles. I've taken some code from [Samuel Kraft's Guide](https://samuelkraft.com/blog/building-a-notion-blog-with-public-api).
+## Getting Started
+1. Clone this repo to your machine: `git clone https://github.com/pasc4le/notion-pretty-print.git`
+2. Go to [Your Notion Integrations](https://www.notion.so/my-integrations) and create a new integration. (This could be either an Internal or Public Integration)
+3. Get the NOTION_DATABASE_ID you want to use for Notion Pretty Print. [Guide](https://stackoverflow.com/questions/67728038/where-to-find-database-id-for-my-database-in-notion)
+4. Create a `.env` file that contains your Integration Token and the Database ID.
+```env
+NOTION_TOKEN=your_token
+NOTION_DATABASE_ID=your_database_id
+```
+5. Build the nextjs webapp with `yarn build`
+6. Start the webapp with `yarn start`
+## Deploy on Vercel
+This project is deployable on vercel.com. Use this button for an easy start:
+
+[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fpasc4le%2Fnotion-pretty-print.git&env=NOTION_TOKEN,NOTION_DATABASE_ID&envDescription=For%20this%20project%20to%20work%20you%20need%20to%20generate%20your%20own%20Notion%20Integration%20secret%20Token%20and%20you%20should%20get%20your%20database%20id.%20Checkout%20the%20README%20for%20more%20info.&envLink=https%3A%2F%2Fgithub.com%2Fpasc4le%2Fnotion-pretty-print)
+## Project Development
+Pull requests are well accepted ☺️