[Docs] Beautify

sundowndev · Feb 26, 2019 · d5fa421 · d5fa421
1 parent a66b879
commit d5fa421
Showing 1 changed file with 50 additions and 50 deletions.
diff --git a/README.md b/README.md
@@ -3,8 +3,8 @@
 </p>
 
 <p align="center">
-  <a href="https://travis-ci.org/sundowndev/leafeon"><img src="https://api.travis-ci.org/sundowndev/leafeon.svg?branch=master" alt="Build status"></a>
-  <a href="https://coveralls.io/github/sundowndev/leafeon?branch=master"><img src="https://coveralls.io/repos/github/sundowndev/leafeon/badge.svg?branch=master" alt="Code coverage"></a>
+  <a href="https://travis-ci.org/sundowndev/leafeon"><img src="https://img.shields.io/travis/sundowndev/leafeon/master.svg?style=flat-square" alt="Build status"></a>
+  <a href="https://coveralls.io/github/sundowndev/leafeon?branch=master"><img src="https://img.shields.io/coveralls/sundowndev/leafeon/master.svg?style=flat-square" alt="Code coverage"></a>
   <a href="https://github.com/sundowndev/leafeon/releases"><img src="https://img.shields.io/github/tag/Sundowndev/leafeon.svg?style=flat-square" alt="Version"></a>
   <a href="#"><img src="https://img.shields.io/badge/minified%20size-4kb-brightgreen.svg?style=flat-square" alt="Size minified"></a>
 </p>
@@ -62,7 +62,54 @@ leafeon.map('docs_', '/docs', [
 ]);
 ~~~
 
-### API
+## Installation (npm)
+
+~~~bash
+$ npm i leafeon
+~~~
+
+#### Usage
+
+```js
+const leafeon = require('leafeon').Router();
+
+leafeon.add('home', '/', function () {
+    document.write('hello world');
+}).run();
+```
+
+## Browser usage
+
+1. Include leafeon.js in **<head>** or at the end of the **<body>**
+
+~~~html
+<script src="leafeon.min.js"></script>
+
+<!-- or via jsdelivr CDN -->
+<script src="https://cdn.jsdelivr.net/gh/sundowndev/leafeon@latest/dist/leafeon.min.js"></script>
+~~~
+
+2. Init the router
+
+~~~js
+const leafeon = new leafeon.Router();
+~~~
+
+3. Create some routes and run the router
+
+~~~js
+leafeon
+    .add('home', '/', () => { /* ... */ })
+    .add('contact', '/contact', () => { /* ... */ })
+    .setErrorCallback(() => { /* ... */ })
+    .run();
+~~~
+
+## Browser support
+
+Supports IE 11+, Chrome 43+, Opera 29+, and Firefox 41+
+
+## API
 
 #### `.add(name: string, path: string, callback: function)`
 
@@ -130,53 +177,6 @@ Register a middleware that will be executed before given path. Type **`*`** to t
 
 Run the router with registered routes. Optionally, register a middleware that will be executed after every routes callback.
 
-## Installation (npm)
-
-~~~bash
-$ npm i leafeon
-~~~
-
-#### Usage
-
-```js
-const leafeon = require('leafeon').Router();
-
-leafeon.add('home', '/', function () {
-    document.write('hello world');
-}).run();
-```
-
-## Browser usage
-
-1. Include leafeon.js in **<head>** or at the end of the **<body>**
-
-~~~html
-<script src="leafeon.min.js"></script>
-
-<!-- or via jsdelivr CDN -->
-<script src="https://cdn.jsdelivr.net/gh/sundowndev/leafeon@latest/dist/leafeon.min.js"></script>
-~~~
-
-2. Init the router
-
-~~~html
-const leafeon = new leafeon.Router();
-~~~
-
-3. Create some routes and run the router
-
-~~~js
-leafeon
-    .add('home', '/', () => { /* ... */ })
-    .add('contact', '/contact', () => { /* ... */ })
-    .setErrorCallback(() => { /* ... */ })
-    .run();
-~~~
-
-## Browser support
-
-Supports IE 11+, Chrome 43+, Opera 29+, and Firefox 41+
-
 ## License
 
 This repository is MIT licensed.