Skip to content

Commit 3c89c60

Browse files
authored
Update README.md
1 parent 4a69ef4 commit 3c89c60

File tree

1 file changed

+56
-2
lines changed

1 file changed

+56
-2
lines changed

README.md

Lines changed: 56 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,56 @@
1-
# DocumentPHP
2-
Documentation Generator for PHP
1+
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
2+
3+
DocumentPHP
4+
=============
5+
6+
What is DocumentPHP?
7+
----------------------
8+
9+
DocumentPHP is an application that is capable of analyzing your PHP source code and fetch the files for making API Documentation Data.
10+
11+
DocumentPHP v0.0.2 (Test)
12+
------------------------------------
13+
14+
v0.0.2 is the developmental release.
15+
16+
Features
17+
--------
18+
19+
DocumentPHP supports the following:
20+
21+
* *PHP 5.4+ compatible*
22+
* *Easy to Use*, you can create your Opencart Documentation Easily.
23+
24+
Installation
25+
------------
26+
27+
DocumentPHP requires PHP 5.4 or higher to run.
28+
However, code of earlier PHP versions can be analyzed.
29+
30+
All templates provided with DocumentPHP have support for Class diagrams based on the read code base.
31+
Rendering is done on Classes.
32+
33+
Install DocumentPHP:
34+
35+
### Via Composer
36+
37+
There is a DocumentPHP composer package that you can use to install DocumentPHP.
38+
39+
How to use DocumentPHP?
40+
-------------------------
41+
42+
To run DocumentPHP after installing via composer and copy the main.php file and make changes accordingly ( file attached in this repo ).
43+
Note- Make Sure the main.php file is at the root location.
44+
45+
Contact
46+
-------
47+
48+
Reaching out to us is easy, and can be done with:
49+
50+
* Twitter: https://twitter.com/codeeshop
51+
* Website: https://www.codeeshop.com
52+
* GitHub: https://github.com/codeeshop-oc/document-php
53+
54+
55+
[Composer]: https://getcomposer.org/
56+
[codeeshop mail]: mailto:[email protected]

0 commit comments

Comments
 (0)