From 6ee6d7240c5cfad93c5f2805196efd3f94aa8294 Mon Sep 17 00:00:00 2001 From: Bhaskar Rijal Date: Fri, 14 Oct 2022 01:54:48 +0545 Subject: [PATCH] add TOC to readme --- README.md | 34 +++++++++++++++++++++++----------- 1 file changed, 23 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index f6557617..c39ec891 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,19 @@ Each project has the following **features**: Here you can [watch a video about this repository](https://www.youtube.com/watch?v=TNzCfgwIDCY). -## Projects +* 1. [Projects](#Projects) + * 1.1. [Tier-1: Beginner Projects](#Tier-1:BeginnerProjects) + * 1.2. [Tier-2: Intermediate Projects](#Tier-2:IntermediateProjects) + * 1.3. [Tier-3: Advanced Projects](#Tier-3:AdvancedProjects) +* 2. [Plans for the future](#Plansforthefuture) +* 3. [Contribution](#Contribution) + * 3.1. [Examples](#Examples) +* 4. [Spread the word!](#Spreadtheword) + * 4.1. [Main Contributors 🙂🙂](#MainContributors) +* 5. [100Days100Projects 🚀](#Days100Projects) +* 6. [Stars history](#Starshistory) + +## 1. Projects Projects are divided into three tiers based on the knowledge and experience required to complete them. @@ -39,7 +51,7 @@ required to complete them. 🌟 - New Project -### Tier-1: Beginner Projects +### 1.1. Tier-1: Beginner Projects | Name | Short Description | Tier | | --------------------------------------------------------------------------------- | ---------------------------------------------------------- | ---------- | @@ -79,7 +91,7 @@ required to complete them. | [Word Frequency](./Projects/1-Beginner/Word-Frequency-App.md) | Calculate word frequency in a block of text | 1-Beginner | | [Weather App](./Projects/1-Beginner/Weather-App.md) | Get the temperature, weather condition of a city. | 1-Beginner | -### Tier-2: Intermediate Projects +### 1.2. Tier-2: Intermediate Projects | Name | Short Description | Tier | | --------------------------------------------------------------------------------- | -------------------------------------------------- | -------------- | @@ -117,7 +129,7 @@ required to complete them. | [Typing Practice](./Projects/2-Intermediate/Typing-Practice-App.md) | Typing Practice | 2-Intermediate | | [Voting App](./Projects/2-Intermediate/Voting-App.md) | Voting App | 2-Intermediate | -### Tier-3: Advanced Projects +### 1.3. Tier-3: Advanced Projects | Name | Short Description | Tier | | ----------------------------------------------------------------------------- | ------------------------------------------------------------------- | ---------- | @@ -142,38 +154,38 @@ required to complete them. | [Spell-It App](./Projects/3-Advanced/SpellIt-App.md) | A twist on the classic Speak N Spell game | 3-Advanced | | [Survey App](./Projects/3-Advanced/Survey-App.md) | Define, conduct, and view a survey | 3-Advanced | -## Plans for the future +## 2. Plans for the future We are planning to add more and more projects to this repository. For this, we need your help! Find out how to contribute below. 👇 We are also planning to create a website where you can easily browse through all of the projects. -## Contribution +## 3. Contribution Any contributions are highly appreciated. :pray: You can contribute in two ways: 1. create an issue and tell us your idea :bulb:. Make sure that you use the **new idea** label in this case; 2. fork the project and submit a PR with your new idea. Before doing that, please make sure that you read and follow the [Contribution Guide](./CONTRIBUTING.md); -### Examples +### 3.1. Examples You can also add your own examples to the projects after you have completed them. I highly encourage you to do this as it will show others what amazing things were built! 👍 -## Spread the word! +## 4. Spread the word! If the information from this repo was useful to you in any way, make sure you give it a star 🌟, this way others can find it and benefit too! Together we can grow and make our community better! :smiley: Do you have any suggestions on how we could improve this project overall? Let us know! We'd love to hear your feedback! -### Main Contributors 🙂🙂 +### 4.1. Main Contributors 🙂🙂 - **Florin Pop**: [Twitter](https://twitter.com/florinpop1705) - [YouTube Channel](https://youtube.com/florinpop) - [website](https://florin-pop.com). - **Jim Medlock**: [Twitter](https://twitter.com/jd_medlock) - [articles](https://medium.com/@jdmedlock) -## 100Days100Projects 🚀 +## 5. 100Days100Projects 🚀 As a bonus, I created the [#100Days100Projects challenge](https://www.florin-pop.com/blog/2019/09/100-days-100-projects). You can find in there 100 more ideas of smaller projects. Enjoy! 😄 -## Stars history +## 6. Stars history [![Stargazers over time](https://starchart.cc/florinpop17/app-ideas.svg)](https://starchart.cc/florinpop17/app-ideas)