Merge pull request #50 from akameco/pr-getting-started

Add getting started

examples/getting-started/.eslintignore

@@ -0,0 +1 @@
+src

examples/getting-started/.flowconfig

@@ -0,0 +1,9 @@
+[ignore]
+
+[include]
+
+[libs]
+
+[lints]
+
+[options]

examples/getting-started/package.json

@@ -0,0 +1,12 @@
+{
+  "scripts": {
+    "flow": "flow",
+    "s2s": "s2s"
+  },
+  "devDependencies": {
+    "flow-bin": "^0.57.3",
+    "s2s": "*",
+    "babel-plugin-s2s-variable-initializing":
+      "file:../../packages/babel-plugin-s2s-variable-initializing"
+  }
+}

examples/getting-started/readme.md

@@ -0,0 +1,22 @@
+# Getting Started
+
+## Install
+
+```
+$ yarn
+```
+
+## Easy Start
+
+```
+$ yarn run flow
+$ yarn run s2s
+```
+
+Open `src/index.js`, and Coding!
+
+[![https://gyazo.com/c6de73c7c9044520fbbca95881c2a927](https://i.gyazo.com/c6de73c7c9044520fbbca95881c2a927.gif)](https://gyazo.com/c6de73c7c9044520fbbca95881c2a927)
+
+## Next
+
+See [examples/shopping-cart](https://github.com/akameco/s2s-plugins/tree/master/examples/shopping-cart)

examples/getting-started/s2s.config.js

@@ -0,0 +1,9 @@
+module.exports = {
+  watch: './**/*.js',
+  plugins: [
+    {
+      test: /.*.js$/,
+      plugin: ['s2s-variable-initializing'],
+    },
+  ],
+}

examples/getting-started/src/index.js

@@ -0,0 +1,10 @@
+/*
+ * @flow
+ * Welcome to s2s https://github.com/akameco/s2s.
+ * This example is very small. However Useful :)
+ * This plugin is that initializing variable with flow information.
+*/
+
+type User = { id: number, name: string }
+
+// type `var user: User` and save!