From 078bb5ab6cf2878b726992463fe6561fa26d7dce Mon Sep 17 00:00:00 2001 From: Kamran Ahmed Date: Thu, 14 Nov 2019 22:30:49 +0400 Subject: [PATCH] Update readme --- readme.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/readme.md b/readme.md index 8b694505c..580ba91c6 100644 --- a/readme.md +++ b/readme.md @@ -15,10 +15,13 @@

-[roadmap.sh](https://roadmap.sh) is the community effort to create knowledge that is approachable for the developers. +roadmap.sh is the community effort to create knowledge that is approachable for the developers. +The website is built with Next.js, contains roadmaps which are the step by step guides for developers, guides which are the easier to understand explanations on the complex topics. Anyone can contribute to the website by suggesting changes to existing paths, adding learning resources, becoming an author by adding new guides, updating the existing guides. -## How to Setup? +## Development + +> Clone the repository, install the dependencies and start the application ```bash git clone https://github.com/kamranahmedse/roadmap.sh @@ -26,4 +29,11 @@ yarn install yarn dev ``` -![](https://i.imgur.com/m7MeL9Q.png) +## Contributions + +* Add new Roadmap +* Suggest changes to existing roadmap +* Write an article +* Improve the site's codebase +* Write tests +