From 7b5aec389e932f06ea9d854684033d326770d5f9 Mon Sep 17 00:00:00 2001 From: bendtherules Date: Wed, 14 Oct 2020 23:03:59 +0530 Subject: [PATCH] Readme - Add basic info And shorten existing Docusaurus commands in readme to a contributing section. --- README.md | 30 +++++++++++++++++++----------- 1 file changed, 19 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index cf461cf..289328a 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,26 @@ -# Website +[![Netlify Status](https://api.netlify.com/api/v1/badges/e3374d45-5349-4ffc-8d52-4c67ee846463/deploy-status)](https://app.netlify.com/sites/uiquestions/deploys) -This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator. +# [Ui Questions](http://uiquestions.com/) -## Installation +> Need a quick review before UI/Frontend interview? Start at http://uiquestions.com/ + +Primary goal of the website is to have "I have 30 minutes before interview"-style coverage of frontend topics. +It should be short, with links to other websites for further reading. + +The first section will be on **DOM and events**, then I'll add some common UI tasks asked in interview, like how to build *infinite scroll*. + + +## Contributing + +This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator. The instructions below is taken from their readme. + +### Installation ```console yarn install ``` -## Local Development +### Local Development ```console yarn start @@ -16,7 +28,7 @@ yarn start This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server. -## Build +### Build ```console yarn build @@ -24,10 +36,6 @@ yarn build This command generates static content into the `build` directory and can be served using any static contents hosting service. -## Deployment +### Deployment -```console -GIT_USER= USE_SSH=true yarn deploy -``` - -If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. \ No newline at end of file +Auto-deployed via Netlify \ No newline at end of file