Update README.md

README.md

@@ -1,22 +1,29 @@
 # ![RealWorld Example App](logo.png)
 
-> ### [YOUR_FRAMEWORK] codebase containing real world examples (CRUD, auth, advanced patterns, etc) that adheres to the [RealWorld](https://github.com/gothinkster/realworld) spec and API.
+> ### Express.js + MongoDB + JavaScript codebase containing real world examples (CRUD, auth, advanced patterns, etc) that adheres to the [RealWorld](https://github.com/gothinkster/realworld) spec and API.
 
 
 ### [Demo](https://demo.realworld.io/)    [RealWorld](https://github.com/gothinkster/realworld)
 
 
-This codebase was created to demonstrate a fully fledged fullstack application built with **[YOUR_FRAMEWORK]** including CRUD operations, authentication, routing, pagination, and more.
+This codebase was created to demonstrate a fully fledged fullstack application built with **Express.js + MongoDB + JavaScript** including CRUD operations, authentication, routing, pagination, and more.
 
-We've gone to great lengths to adhere to the **[YOUR_FRAMEWORK]** community styleguides & best practices.
+We've gone to great lengths to adhere to the **Express.js + MongoDB + JavaScript** community styleguides & best practices.
 
 For more information on how to this works with other frontends/backends, head over to the [RealWorld](https://github.com/gothinkster/realworld) repo.
 
+# Getting started
+
+1. install npm
+1. Run `npm install` in the project folder
+1. Run `npm run dev` for dev mode and `npm run start` for regualr mode
 
 # How it works
 
-> Describe the general architecture of your app here
+> All the routes are defined in the `src/routes` folder, and their corresponding controllers are implemented in the `src/controllers` folder.
 
-# Getting started
+# Design Choices and Tradeoffs
 
-> npm install, npm start, etc.
+- Only one `access_token_secret` is used for all the accounts registration and login. Drawback: data can be forged if this secret is leaked
+- Included array structures, e.g. list of comments in the article model and favorited articles in the user model. Drawback: not good for scalability
+- Usernames are case-sensitive