docsify init

volatiletech · Sep 18, 2020 · ee9b9a6 · ee9b9a6
1 parent c7811eb
commit ee9b9a6
Show file tree

Hide file tree

Showing 4 changed files with 64 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -39,6 +39,8 @@ Here are a few bullet point reasons you might like to try it out:
 * Saves you mistakes (at least using Authboss, people can bug fix as a collective and all benefit)
 * Should integrate with or without any web framework
 
+# [Click Here To Get Started]("TODO")
+
 # Readme Table of Contents
 <!-- TOC -->
 

diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,30 @@
+<img src="http://i.imgur.com/fPIgqLg.jpg"/>
+
+# Authboss
+
+[![GoDoc](https://img.shields.io/badge/godoc-reference-5272B4)](https://pkg.go.dev/mod/github.com/volatiletech/authboss/v3)
+![ActionsCI](https://github.com/volatiletech/authboss/workflows/test/badge.svg)
+[![Mail](https://img.shields.io/badge/mail%20list-authboss-lightgrey.svg)](https://groups.google.com/a/volatile.tech/forum/#!forum/authboss)
+
+Authboss is a modular authentication system for the web.
+
+It has several modules that represent authentication and authorization features that are common
+to websites in general so that you can enable as many as you need, and leave the others out.
+It makes it easy to plug in authentication to an application and get a lot of functionality
+for (hopefully) a smaller amount of integration effort.
+
+### Why use Authboss?
+
+Every time you'd like to start a new web project, you really want to get to the heart of what you're
+trying to accomplish very quickly and it would be a sure bet to say one of the systems you're excited
+about implementing and innovating on is not authentication. In fact it's very much the opposite: it's
+one of those things that you have to do and one of those things you loathe to do. Authboss is supposed
+to remove a lot of the tedium that comes with this, as well as a lot of the chances to make mistakes.
+This allows you to care about what you're intending to do, rather than care about ancillary support
+systems required to make what you're intending to do happen.
+
+Here are a few bullet point reasons you might like to try it out:
+
+* Saves you time (Authboss integration time should be less than re-implementation time)
+* Saves you mistakes (at least using Authboss, people can bug fix as a collective and all benefit)
+* Should integrate with or without any web framework
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,32 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>Authboss Docs</title>
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+  <meta name="description" content="Description">
+  <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
+  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/lib/themes/vue.css">
+</head>
+<body>
+  <div id="app"></div>
+  <script>
+    window.$docsify = {
+      search: {
+        paths: 'auto',
+        placeholder: 'Type to search',
+        noData: 'No Results!',
+        depth: 6,
+        hideOtherSidebarContent: false,
+      },
+      name: 'Authboss Docs',
+      repo: 'https://github.com/volatiletech/authboss',
+      loadSidebar: true,
+      subMaxLevel: 3
+    }
+  </script>
+  <script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>
+  <script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/search.min.js"></script>
+  <script src="https://cdn.jsdelivr.net/npm/prismjs@1/components/prism-go.min.js"></script>
+</body>
+</html>