From 52ee54d9e6f99939b449d10a3ddcd7b830c22913 Mon Sep 17 00:00:00 2001 From: jamesramm Date: Fri, 28 Dec 2018 09:46:53 +0000 Subject: [PATCH] GitBook: [master] 8 pages modified --- .github/ISSUE_TEMPLATE.md | 8 -------- .github/README.md | 2 ++ .github/issue_template.md | 10 ++++++++++ README.md | 27 +++++++++++++++++++++++++++ SUMMARY.md | 8 ++++++++ longclaw/README.md | 2 ++ longclaw/client.md | 9 +++++++++ longclaw/client/README.md | 9 --------- 8 files changed, 58 insertions(+), 17 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/README.md create mode 100644 .github/issue_template.md create mode 100644 README.md create mode 100644 SUMMARY.md create mode 100644 longclaw/README.md create mode 100644 longclaw/client.md delete mode 100644 longclaw/client/README.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index db3bebb..0000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,8 +0,0 @@ -* longclaw version: -* Django version: -* Python version: - -### Description - -Describe what you were trying to get done. -Tell us what happened, what went wrong, and what you expected to happen. diff --git a/.github/README.md b/.github/README.md new file mode 100644 index 0000000..c41e0e0 --- /dev/null +++ b/.github/README.md @@ -0,0 +1,2 @@ +# .github + diff --git a/.github/issue_template.md b/.github/issue_template.md new file mode 100644 index 0000000..caa6aa7 --- /dev/null +++ b/.github/issue_template.md @@ -0,0 +1,10 @@ +# ISSUE\_TEMPLATE + +* longclaw version: +* Django version: +* Python version: + +## Description + +Describe what you were trying to get done. Tell us what happened, what went wrong, and what you expected to happen. + diff --git a/README.md b/README.md new file mode 100644 index 0000000..42bcf2a --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +--- +description: Longclaw is an e-commerce extension for Wagtail CMS +--- + +# Longclaw + +## Getting Super Powers + +Becoming a super hero is a fairly straight forward process: + +``` +$ give me super-powers +``` + +{% hint style="info" %} + Super-powers are granted randomly so please submit an issue if you're not happy with yours. +{% endhint %} + +Once you're strong enough, save the world: + +``` +// Ain't no code for that yet, sorry +echo 'You got to trust me on this, I saved the world' +``` + + + diff --git a/SUMMARY.md b/SUMMARY.md new file mode 100644 index 0000000..7540914 --- /dev/null +++ b/SUMMARY.md @@ -0,0 +1,8 @@ +# Table of contents + +* [Longclaw](README.md) +* [.github](.github/README.md) + * [ISSUE\_TEMPLATE](.github/issue_template.md) +* [longclaw](longclaw/README.md) + * [Frontend libraries for Longclaw](longclaw/client.md) + diff --git a/longclaw/README.md b/longclaw/README.md new file mode 100644 index 0000000..04927ab --- /dev/null +++ b/longclaw/README.md @@ -0,0 +1,2 @@ +# longclaw + diff --git a/longclaw/client.md b/longclaw/client.md new file mode 100644 index 0000000..a46293a --- /dev/null +++ b/longclaw/client.md @@ -0,0 +1,9 @@ +# Frontend libraries for Longclaw + +This library contains a javascript client for the [Longclaw e-commerce library](client.md). + +There are two options for using this library: + +1. Install with npm \(`npm i longclawclient --save`\) and then use as you would any other es6+ module \(i.e. as part of a webpack or similar workflow\) +2. Use the built distribution in HTML/browser scripts by loading it with the templatetags provided with Longclaw. The api library will be exposed as a global object named `longclawclient` + diff --git a/longclaw/client/README.md b/longclaw/client/README.md deleted file mode 100644 index 0a077bd..0000000 --- a/longclaw/client/README.md +++ /dev/null @@ -1,9 +0,0 @@ -## Frontend libraries for Longclaw - -This library contains a javascript client for the [Longclaw e-commerce library](). - -There are two options for using this library: - -1. Install with npm (`npm i longclawclient --save`) and then use as you would any other es6+ module (i.e. as part of a webpack or similar workflow) - -2. Use the built distribution in HTML/browser scripts by loading it with the templatetags provided with Longclaw. The api library will be exposed as a global object named `longclawclient` \ No newline at end of file