From 83d783e34eae58d546af664d05f1bbf82dee0c0d Mon Sep 17 00:00:00 2001 From: endiliey Date: Fri, 20 Jul 2018 23:49:49 +0800 Subject: [PATCH 1/2] Better readme :) --- README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index bc7caf7ac5a7..ddb0f59fb2f5 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,18 @@ -# [Docusaurus](https://docusaurus.io) · [![npm version](https://img.shields.io/npm/v/docusaurus.svg?style=flat)](https://www.npmjs.com/package/docusaurus) [![CircleCI Status](https://circleci.com/gh/facebook/Docusaurus.svg?style=shield)](https://circleci.com/gh/facebook/Docusaurus) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](CONTRIBUTING.md#pull-requests) - +

+

Docusaurus

+ Docusaurus +

+ +

+ npm version + CircleCI Status + PRs Welcome + Chat + code style: prettier + Tested with Jest +

+ +## Intro Docusaurus is a project for easily building, deploying, and maintaining open source project websites. * **Simple to Start** Docusaurus is built to be easy to [get up and running](https://docusaurus.io/docs/en/installation.html) in as little time possible. We've built Docusaurus to handle the website build process so you can focus on your project. From 3c9a2ee361553b5fc5c9ebd4fcf7dcc3c9521223 Mon Sep 17 00:00:00 2001 From: Yangshun Tay Date: Fri, 20 Jul 2018 11:12:05 -0700 Subject: [PATCH 2/2] Update README.md --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ddb0f59fb2f5..2858a65b0fc0 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,8 @@ Tested with Jest

-## Intro +## Introduction + Docusaurus is a project for easily building, deploying, and maintaining open source project websites. * **Simple to Start** Docusaurus is built to be easy to [get up and running](https://docusaurus.io/docs/en/installation.html) in as little time possible. We've built Docusaurus to handle the website build process so you can focus on your project.