Adds docs. (#4)

skellock · web-flow · commit 578a53ec9922 · 2017-07-15T21:05:51.000-04:00
diff --git a/README.md b/README.md
@@ -1,73 +1,28 @@
-# Electron Starter
+# electron-starter
 
-This is my own personal electron starter kit.
+This is a electron starter kit from some random guy on the Internet.
 
-I will be bikeshedding with myself. I'm going to change my mind quite a bit.  You might prefer something more stable.
+[Check out the docs](https://skellock.github.io/electron-starter) for all the gory details.
 
-Still here?  Ok, let's do this.
+### Why?
 
-# Test Drive
+I've got dozens of Electron apps started and not finished. They die before they can leave the bikeshed.
 
-Want to try this out? Clone & run.  There's a small sample project included.
+This is my attempt to fix that.
 
-```sh
-git clone git@github.com:skellock/electron-starter.git
-cd electron-starter
-npm i
-npm start
-```
 
-_Requires `node@>=8.1` and `npm@>=5.2`._
+### Why Not?
 
-# Start Your Own Project
+Oh man... lots of reasons. There's other starter ones out there. That use things like WebPack, Babel, Flow, and Redux.
 
-Ready to start your project?
+This pack o' tools is slightly off the main stream. I mean, don't get me wrong, it's not full on hipster, but does have hipster-like tendencies. It's not as far as say, `reason`, `elm`, or `purescript`. I'm not that crazy or brave yet.
 
-I'm still deciding on a simple way, but there will be a script you can run.
+The tools in this pack do **less**. They have less config. Less API. Less plugins.
 
-```sh
-npm run time-to-shine
-```
+I need more **less** in my life.
 
-# Using
 
-Your source files will live in the `src/main` and `src/renderer` directories.
+### License
 
-To build your apps, first bundle it:
+MIT. A tip of the hat is always nice, but I'm more interested in hearing what you do with it.
 
-```sh
-npm run compile
-```
-
-Then you can `pack` a copy to see what it will look like assembled:
-
-```sh
-npm run pack
-npm run dist
-```
-
-And when you're ready to ship:
-
-```sh
-npm run dist
-```
-
-To create a .zip and .dmg.
-
-
-# What's Inside?
-
-libs | why
------|------
-**react**, **react-dom** | Can't imagine doing web differently to be honest. I'm sure we will soon, but for mid-2017, this is dominating.
-**mobx**, **mobx-state-tree**, **mobx-react** | It brings the same things to the table as Redux, but with considerably less typing.
-**ramda** | Lodash/fp is also a good choice here. I like ramda because I'm comfortable with it. `pipe` for life.
-**typescript**, **tslint** | Such a well polished and wonderful typing system. I know this is a stepping stone to a better language, but JavaScript is really comfortable at this point. TypeScript dials the safety part in.
-**fuse-box** | A fantastic bundler. WebPack always rubbed me wrong. Maybe it's the config? Maybe it's the way they name things? I'm not sure. What I do know is, once I started playing with FuseBox, I was sold. I like the devs behind this too.
-**husky**, **lint-staged**, **prettier** | Some automation so I stop checking in crap looking code.
-**ava** | This is my favourite testing framework. I've tried them all. The devs behind this are very talented, helpful, and friendly.
-**npm-scripts-info**, **npm-run-all** | Quality-of-life utilities for npm.
-
-# License
-
-MIT
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,11 @@
+# electron-starter
+
+This is my own personal electron starter kit.
+
+I will be bikeshedding with myself. I'm going to change my mind quite a bit.  You might prefer something more stable.
+
+Still here?  Ok, let's do this.
+
+### License
+
+MIT
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -0,0 +1,3 @@
+- [Home](/)
+- [Using](/using)
+- [The Stack](/stack)
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>electron-starter - start building crap.</title>
+  <meta name="description" content="Start building your Electron app.">
+  <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="https://unpkg.com/docsify/themes/vue.css">
+</head>
+<body>
+  <div id="app"></div>
+</body>
+<script>
+  window.$docsify = {
+    loadSidebar: true,
+    subMaxLevel: 2,
+    repo: 'skellock/electron-starter',
+    name: 'electron-starter',
+    coverpage: true,
+    search: 'auto',
+    search: [
+      '/',
+      'stack'
+    ]
+  }
+</script>
+<script src="https:////unpkg.com/docsify/lib/docsify.js"></script>
+<script src="https:////unpkg.com/docsify/lib/plugins/search.js"></script>
+<script src="https:////unpkg.com/docsify/lib/plugins/emoji.js"></script>
+<script src="https:////unpkg.com/prismjs/components/prism-bash.js"></script>
+<script src="https:////unpkg.com/prismjs/components/prism-jsx.js"></script>
+</html>
diff --git a/docs/stack.md b/docs/stack.md
@@ -0,0 +1,83 @@
+# The Stack
+
+Hey, so everyone has their favourites right? Here's a few of mine.
+
+## Language
+
+> **typescript**
+
+Such a well polished and wonderful typing system. I know this is a stepping stone to a better language, but JavaScript is really comfortable at this point. TypeScript dials the safety part in.
+
+
+## Language Support
+
+> **tslint**
+
+A linter with a great set of rules is awesome.
+
+> **husky**, **lint-staged**, **prettier**
+
+Some automation so I stop checking in crap-looking code.
+
+
+## Rendering
+
+> **react**, **react-dom**
+
+Can't imagine doing web differently to be honest. I'm sure we will soon, but for mid-2017, this is dominating.
+
+
+## State Management
+
+> **mobx**, **mobx-react**
+
+It brings the same things to the table as `redux`, but with considerably less typing.
+
+> **mobx-state-tree**
+
+A nice little addition from the `mobx` team. It brings `redux`-like state trees, immutability, and type guarantees. Love it.
+
+
+## Utilities
+
+> **ramda** 
+
+There's so much awesome packed in here. `pipe` for days. I'll be honest, it took me a long time get comfortable with `ramda`. Nowadays, you can pry it from my cold dead hands. PRECIOUS!!!
+
+
+## Bundler
+
+> **fuse-box**
+
+Yes, you read that right. Not WebPack. WebPack always rubbed me wrong. Maybe it's the config? Maybe it's the way they name things? I'm not sure.
+
+What I do know is, once I started playing with FuseBox, I was sold. I like the devs behind this too.
+
+
+## Testing
+
+> **ava**
+
+This is my favourite testing framework. I've tried them all. The devs behind this are very talented, helpful, and friendly.
+
+
+## Compile Time Utilities
+
+> **npm-scripts-info**, **npm-run-all**
+
+Quality-of-life utilities for npm.
+
+
+## Docs
+
+> **docsify**
+
+You're reading it right now.
+
+* No build-time required.
+* Themeable.
+* Drops in your `master` branch.
+* Supports plugins.
+* Hooks up to github without deployment scripts.
+
+Love it.
diff --git a/docs/using.md b/docs/using.md
@@ -0,0 +1,44 @@
+## Test Drive
+
+Want to try this out? Clone & run.  There's a small sample project included.
+
+```sh
+git clone git@github.com:skellock/electron-starter.git
+cd electron-starter
+npm i
+npm start
+```
+
+_Requires `node@>=8.1` and `npm@>=5.2`._
+
+## Start Your Own Project
+
+Ready to start your project?
+
+I'm still deciding on a simple way, but there will be a script you can run.
+
+```sh
+npm run time-to-shine
+```
+
+## Building
+
+To build your apps, first bundle it:
+
+```sh
+npm run compile
+```
+
+Then you can `pack` a copy to see what it will look like assembled:
+
+```sh
+npm run pack
+```
+
+And when you're ready to ship:
+
+```sh
+npm run dist
+```
+
+To create a .zip and .dmg in the `dist` directory.

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+- [Home](/)`
	`2`	`+- [Using](/using)`
	`3`	`+- [The Stack](/stack)`