From 8c98194fb658c50fb3557a483970698e76999728 Mon Sep 17 00:00:00 2001
From: Lisachenko Alexander <lisachenko.it@gmail.com>
Date: Mon, 15 Feb 2016 21:47:40 +0300
Subject: [PATCH] Fix typo in the name and add index file

---
 docs/README.md                                | 22 +++++++++++++++++++
 ...relection_class.md => reflection_class.md} |  0
 .../{relection_file.md => reflection_file.md} |  0
 ...espace.md => reflection_file_namespace.md} |  0
 ...ion_function.md => reflection_function.md} |  0
 ...lection_method.md => reflection_method.md} |  0
 ...n_parameter.md => reflection_parameter.md} |  0
 ...ion_property.md => reflection_property.md} |  0
 .../{relection_type.md => reflection_type.md} |  0
 9 files changed, 22 insertions(+)
 create mode 100644 docs/README.md
 rename docs/{relection_class.md => reflection_class.md} (100%)
 rename docs/{relection_file.md => reflection_file.md} (100%)
 rename docs/{relection_file_namespace.md => reflection_file_namespace.md} (100%)
 rename docs/{relection_function.md => reflection_function.md} (100%)
 rename docs/{relection_method.md => reflection_method.md} (100%)
 rename docs/{relection_parameter.md => reflection_parameter.md} (100%)
 rename docs/{relection_property.md => reflection_property.md} (100%)
 rename docs/{relection_type.md => reflection_type.md} (100%)

diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 00000000..73a08a59
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,22 @@
+ParserReflection API Reference
+==============
+
+Introduction
+--------
+PHP comes with a complete reflection API that adds the ability to reverse-engineer classes, interfaces, functions, methods and extensions. Additionally, the reflection API offers ways to retrieve doc comments for functions, classes and methods.
+
+But this reflection API requires concrete element to be loaded into the memory. Once element is loaded, it can not be changed, modified or updated without special extensions. 
+
+`goaop\parser-reflection` packet is a userland implementation of reflection API that is fully compatible with internal one, but doesn't require element (e.g. class or function) to be loaded into the PHP. Only the source code is required for performing the raw analysis.
+
+Reference
+---------
+
+- [`ReflectionClass`](reflection_class.md)
+- [`ReflectionFile`](reflection_file.md)
+- [`ReflectionFileNamespace`](reflection_file_namespace.md)
+- [`ReflectionFunction`](reflection_function.md)
+- [`ReflectionMethod`](reflection_method.md)
+- [`ReflectionParameter`](reflection_parameter.md)
+- [`ReflectionProperty`](reflection_property.md)
+- [`ReflectionType`](reflection_type.md)
diff --git a/docs/relection_class.md b/docs/reflection_class.md
similarity index 100%
rename from docs/relection_class.md
rename to docs/reflection_class.md
diff --git a/docs/relection_file.md b/docs/reflection_file.md
similarity index 100%
rename from docs/relection_file.md
rename to docs/reflection_file.md
diff --git a/docs/relection_file_namespace.md b/docs/reflection_file_namespace.md
similarity index 100%
rename from docs/relection_file_namespace.md
rename to docs/reflection_file_namespace.md
diff --git a/docs/relection_function.md b/docs/reflection_function.md
similarity index 100%
rename from docs/relection_function.md
rename to docs/reflection_function.md
diff --git a/docs/relection_method.md b/docs/reflection_method.md
similarity index 100%
rename from docs/relection_method.md
rename to docs/reflection_method.md
diff --git a/docs/relection_parameter.md b/docs/reflection_parameter.md
similarity index 100%
rename from docs/relection_parameter.md
rename to docs/reflection_parameter.md
diff --git a/docs/relection_property.md b/docs/reflection_property.md
similarity index 100%
rename from docs/relection_property.md
rename to docs/reflection_property.md
diff --git a/docs/relection_type.md b/docs/reflection_type.md
similarity index 100%
rename from docs/relection_type.md
rename to docs/reflection_type.md