Merge pull request #512 from ydah/readme

Add documentation in README and gemspec

README.md

@@ -6,32 +6,32 @@
 
 Lrama is LALR (1) parser generator written by Ruby. The first goal of this project is providing error tolerant parser for CRuby with minimal changes on CRuby parse.y file.
 
-- [Lrama](#lrama)
-  - [Features](#features)
-  - [Installation](#installation)
-  - [Usage](#usage)
-  - [Versions and Branches](#versions-and-branches)
-    - [v0\_7 (`master` branch)](#v0_7-master-branch)
-    - [v0\_6 (`lrama_0_6` branch)](#v0_6-lrama_0_6-branch)
-    - [v0\_5 (`lrama_0_5` branch)](#v0_5-lrama_0_5-branch)
-    - [v0\_4 (`lrama_0_4` branch)](#v0_4-lrama_0_4-branch)
-  - [Supported Ruby version](#supported-ruby-version)
-  - [Development](#development)
-    - [How to generate parser.rb](#how-to-generate-parserrb)
-    - [How to Write a Type Signature](#how-to-write-a-type-signature)
-    - [Test](#test)
-    - [Call-stack Profiling Lrama](#call-stack-profiling-lrama)
-      - [1. Create parse.tmp.y in ruby/ruby](#1-create-parsetmpy-in-rubyruby)
-      - [2. Enable Profiler](#2-enable-profiler)
-      - [3. Run Lrama](#3-run-lrama)
-      - [4. Generate Flamegraph](#4-generate-flamegraph)
-    - [Memory Profiling Lrama](#memory-profiling-lrama)
-      - [1. Create parse.tmp.y in ruby/ruby](#1-create-parsetmpy-in-rubyruby-1)
-      - [2. Enable Profiler](#2-enable-profiler-1)
-      - [3. Run Lrama](#3-run-lrama-1)
-    - [Build Ruby](#build-ruby)
-  - [Release flow](#release-flow)
-  - [License](#license)
+- [Features](#features)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Documentation](#documentation)
+- [Versions and Branches](#versions-and-branches)
+  - [v0\_7 (`master` branch)](#v0_7-master-branch)
+  - [v0\_6 (`lrama_0_6` branch)](#v0_6-lrama_0_6-branch)
+  - [v0\_5 (`lrama_0_5` branch)](#v0_5-lrama_0_5-branch)
+  - [v0\_4 (`lrama_0_4` branch)](#v0_4-lrama_0_4-branch)
+- [Supported Ruby version](#supported-ruby-version)
+- [Development](#development)
+  - [How to generate parser.rb](#how-to-generate-parserrb)
+  - [How to Write a Type Signature](#how-to-write-a-type-signature)
+  - [Test](#test)
+  - [Call-stack Profiling Lrama](#call-stack-profiling-lrama)
+    - [1. Create parse.tmp.y in ruby/ruby](#1-create-parsetmpy-in-rubyruby)
+    - [2. Enable Profiler](#2-enable-profiler)
+    - [3. Run Lrama](#3-run-lrama)
+    - [4. Generate Flamegraph](#4-generate-flamegraph)
+  - [Memory Profiling Lrama](#memory-profiling-lrama)
+    - [1. Create parse.tmp.y in ruby/ruby](#1-create-parsetmpy-in-rubyruby-1)
+    - [2. Enable Profiler](#2-enable-profiler-1)
+    - [3. Run Lrama](#3-run-lrama-1)
+  - [Build Ruby](#build-ruby)
+- [Release flow](#release-flow)
+- [License](#license)
 
 ## Features
 
@@ -84,6 +84,10 @@ Enter the formula:
 => 9
 ```
 
+## Documentation
+
+https://ruby.github.io/lrama/ provides a comprehensive guide to Lrama's features and usage.
+
 ## Versions and Branches
 
 ### v0_7 (`master` branch)

lrama.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata["homepage_uri"]      = spec.homepage
   spec.metadata["source_code_uri"]   = spec.homepage
-  spec.metadata["documentation_uri"] = spec.homepage
+  spec.metadata["documentation_uri"] = "https://ruby.github.io/lrama/"
   spec.metadata["changelog_uri"]     = "#{spec.homepage}/releases"
   spec.metadata["bug_tracker_uri"]   = "#{spec.homepage}/issues"