Improve README.md

kachick · May 30, 2021 · 035a8fc · 035a8fc
1 parent 64b5121
commit 035a8fc
Showing 1 changed file with 9 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -1,23 +1,15 @@
-declare
-=======
+# declare
 
 ![Build Status](https://github.com/kachick/declare/actions/workflows/test_behaviors.yml/badge.svg?branch=main)
 [![Gem Version](https://badge.fury.io/rb/declare.png)](http://badge.fury.io/rb/declare)
 
-Description
-------------
-
 A unit testing framework
 
-Features
---------
-
-* Simple syntax.
-* Markdown looks Reports.
+* Simple syntax
+* Markdown looks Reports
 * Tiny keyboard typings :)
 
-Usage
------
+## Usage
 
 Require Ruby 2.5 or later
 
@@ -112,3 +104,8 @@ to
 ```ruby
 require 'declare/autorun'
 ```
+
+## Links
+
+* [Repository](https://github.com/kachick/declare)
+* [API documents](https://kachick.github.io/declare)