From f8724ac3c615bf8e20f4bce79d6047ddf141a36c Mon Sep 17 00:00:00 2001 From: James Brooks Date: Sun, 28 Dec 2014 23:50:14 +0000 Subject: [PATCH] Begin writing some documentation --- docs/api/making-requests.md | 6 ++++++ docs/index.md | 8 ++++++++ docs/intro/index.md | 9 +++++++++ 3 files changed, 23 insertions(+) create mode 100644 docs/intro/index.md diff --git a/docs/api/making-requests.md b/docs/api/making-requests.md index 18f22c14..facc4486 100644 --- a/docs/api/making-requests.md +++ b/docs/api/making-requests.md @@ -1 +1,7 @@ # Making requests + +## Endpoint + +## Authorization + +## Security diff --git a/docs/index.md b/docs/index.md index 6eda30e0..c459849f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,5 +1,13 @@ # Cachet Documentation +Cachet is an open source alternative to StatusPage.io written in PHP 5 with the Laravel 4.2 framework. + ## Table of contents +### Introduction + +- [Introduction to Cachet](/docs/intro/index.md) + ### API + +- [Cachet API](/docs/api/index.md) diff --git a/docs/intro/index.md b/docs/intro/index.md new file mode 100644 index 00000000..32438873 --- /dev/null +++ b/docs/intro/index.md @@ -0,0 +1,9 @@ +# Introduction to Cachet + +This document is a brief breakdown of what Cachet is, why it was built and how it works. Each section is explained in more detail within other pages. + +## What is Cachet? + +## Why build it? + +## How does it work?