Overview

• How to let others know the purpose of this repo quickly?
• What are the problems this repo want to solve?

Pre requisition / Installation

• What environment you need first for running this application?
• What packages you need to install first?
• Imagine that you want to read and understanding an article or news, you must need to learn some basic knowledge to correctly catch up and understand the information. To correctly running our application, we need to install the correct environment first.

Quick Start

• How to let user earn the first success experiment?
• Quick start should be easy and reproducible.
• Do not disclosure to much details.

Details / Advance

• After finish the quick start stage, the user have gain some experience in some extend.
• With the chunks of experience, user have some basic to understand the details of informations or maybe they don’t even need to understand.
• The details or advance should be optional informations.