Skip to content

Commit

Permalink
trying docs again
Browse files Browse the repository at this point in the history
  • Loading branch information
MelonSmasher committed Jun 9, 2017
1 parent 2ad3c74 commit d0b1cba
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 5 deletions.
4 changes: 2 additions & 2 deletions docs/Install.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Install
# ORM Core Install

### Requirements:

Expand All @@ -20,7 +20,7 @@ PHP Packages:
- php-xml
- php-fpm (NGINX only)

---
### Install:

* Step 1: [Install NGINX](https://github.com/MelonSmasher/NginxInstaller)

Expand Down
34 changes: 31 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,42 @@ ORM Core is a REST API designed to house institutional data and act as an interm

---

### Installation
##### Features

* REST API interface
* API manager front end
* API manager admin back end
* API Accounts for different applications
* Account permissions and access control
* JWT authentication
* API rate limit/throttle
* API event history
* Log viewer
* Mobile Phone and Email verification
* API metrics and statistics
* API Event broadcast to event manager for 3rd party applications
* Interactive documentation using OpenAPI fka(Swagger)

##### Installation

See the [installation docs](Install.md)

### Update
##### Update

See the [update docs](Update.md)

### API Specification
##### API Specification

See the [API spec](Specification.md)

##### Related Software

Some cool projects that this software relies on.

* [Laravel](https://laravel.com)
* [rappasoft/laravel-5-boilerplate](https://github.com/rappasoft/laravel-5-boilerplate)
* [dingo/api](https://github.com/dingo/api)
* [tymon/jwt-auth](https://github.com/tymon/jwt-auth)
* [simplesoftwareio/simple-sms](https://github.com/simplesoftwareio/simple-sms)
* [snowfire/beautymail](https://github.com/snowfire/beautymail)
* [edvinaskrucas/settings](https://github.com/edvinaskrucas/settings)

0 comments on commit d0b1cba

Please sign in to comment.