Find or share book summaries in three sentences (or less)
This part requires you to know little about git & how to raise a PR.
There is no need to worry if you don't know. Read this guide & you'll learn how to submit a PR. If something doesn't make sense then try to google & if you have more questions then don't hesitate to reach me out on twitter or raise an issue, I'll be happy to help :)
- Fork this project repository & then clone the fork to your machine.
- Create a new Branch by following the name convention of
add-user-YOUR_GITHUB_USERNAME
. - Under the
data
directory, create a newmdx
file with yourGITHUB_USERNAME
as file name. For example,AyushSaini00.mdx
. - Add the book summaries you want with your information into your file using the following format:
---
name: 'Ayush Saini'
twitter: '@AyushCodes'
url: 'https://www.ayushsaini.com'
updatedAt: '2021-01-17'
tags: ['Self help', 'Fiction', 'Travel', 'Health', 'Motivational', 'How to']
---
## Book 1
1. line number 1
2. line number 2
3. line number 3
## Book 2
1. line number 1
2. line number 2
3. line number 3
- Commit your changes & Open a PR (Pull Request). I'll add your page then :)
Once your PR is merged with the project, you can view your page at bookin3.vercel.app/<YOUR_GITHUB_USERNAME>
.
You can also find your profile at the homepage of bookin3.vercel.app
. Right now the profiles are arranged according to the recently updated page.
Pull requests are always welcome. If you want to add something to this project then just raise an PR or look existing ones in issues β¨
β‘ Built by Ayush, as a part of his quest to hopefully read, understand, and learn from more books this year :)