Added readme

Author: Devorein

README.md

@@ -0,0 +1,109 @@
+<h1 align="center">Github Readme Learn Section - <i>Github Action</i></h1>
+<div align="center"><b>Automatically update your github README learn section with data fetched from a remote notion database.</b></div>
+</br>
+<p align="center">
+  <a href="https://app.codecov.io/gh/Devorein/github-action-learn-section-notion/branch/master"><img src="https://img.shields.io/codecov/c/github/devorein/github-action-learn-section-notion?color=blue"/></a>
+  <a href="https://github.com/Devorein/github-action-learn-section-notion/actions/workflows/build.yml"><img src="https://github.com/devorein/github-action-learn-section-notion/actions/workflows/build.yml/badge.svg"/></a>
+  <img src="https://img.shields.io/github/repo-size/devorein/github-action-learn-section-notion?style=flat-square&color=orange"/>
+  <img src="https://img.shields.io/github/contributors/devorein/github-action-learn-section-notion?label=contributors&color=red"/>
+</p>
+
+## Configuration
+
+|    Option     |                    Description                    | Default |
+| :-----------: | :-----------------------------------------------: | :-----: |
+| `database_id` | Set this to the id of your remote notion database |    -    |
+|  `token_v2`   |        Set this to your notion `token_v2`         |    -    |
+
+## Usage
+
+### In Repository File
+
+#### 1. Add the following content to your `README.md`
+
+```markdown
+## What I know so far
+
+<!--START_SECTION:learn-->
+<!--END_SECTION:learn-->
+```
+
+#### 2. Configure the workflow
+
+```yaml
+name: 'Github Readme Updater'
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '0 0 * * *' # Runs Every Day
+jobs:
+  update_learn:
+    name: 'Update learn section'
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'Fetching Repository Contents'
+        uses: actions/checkout@main
+      - name: 'Learn Section Updater'
+        uses: 'devorein/github-action-learn-section-notion@master'
+        with:
+          database_id: '6626c1ebc5a44db78e3f2fe285171ab7'
+          token_v2: ${{ secrets.NOTION_TOKEN_V2 }}
+```
+
+### In your notion account
+
+#### 1. Create a full page database
+
+![Notion Full Page Database](./media/notion_full_page_db.png)
+
+**NOTE**: Your database must maintain the following structure/schema
+
+|   Name   |  Type  | Required | Default |               Description               |                                      Value                                      |      Example      |
+| :------: | :----: | :------: | :-----: | :-------------------------------------: | :-----------------------------------------------------------------------------: | :---------------: |
+|   Name   | title  |   true   |    -    |   The name of the item you've learnt    | Must be a valid icon from `https://simple-icons.github.io/simple-icons-website` | React, Typescript |
+| Category | select |   true   |    -    | The category under which the item falls |                                   Any string                                    | Language, Library |
+|  Color   |  text  |  false   |  black  |      Background Color of the badge      |               Any keyword color or hex value without alpha and #                |    red,00ff00     |
+
+#### 2. Get the id of the database
+
+![Notion Full Page Database Id](./media/notion_full_page_db_id.png)
+
+#### 3. Add it in workflow file
+
+```yaml
+with:
+  database_id: '6626c1ebc5a44db78e3f2fe285171ab7'
+```
+
+#### 4. Get your notion `token_v2`
+
+**NOTE**: By no means should you share or expose your notion `token_v2`. If you feel like you've done so accidentally, immediately log out from that account in all of your devices.
+
+Follow the steps below to obtain your `token_v2`:
+
+1. Open up the devtools of your preferred browser.
+2. Go to the Application > Cookies section.
+3. There you'll find a `token_v2` cookie.
+
+**NOTE**: Its highly recommended to store your `token_v2` as a github secret rather than pasting it in your workflow file.
+
+#### 5. Create a github secret to store `token_v2`
+
+1. navigate to the url `https://github.com/<USERNAME>/<REPO-NAME>/settings/secrets/actions`
+2. Click on `New repository secret`
+3. You can name your secret as anything you want
+4. Paste the `token_v2` value in the `Value` textarea
+5. Use the secret in your workflow file
+
+```yaml
+with:
+  token_v2: ${{ secrets.NOTION_TOKEN_V2 }} # The secret was named NOTION_TOKEN_V2
+```
+
+### Outcome
+
+If you follow all the steps properly your readme should look something like this.
+
+![Github Readme Learn Section](./media/github_readme_learn_section.png)
+
+Feel free to submit a pull request or open a new issue, contributions are more than welcome !!!