updated docs

searchkit · 3861cef39ca0dab7989fd75febf640150d7c67c0 · joemcelroy committed Jan 3, 2016 · Jan 3, 2016 · 3861cef
1 parent 035cf35
commit 3861cef39ca0dab7989fd75febf640150d7c67c0
Unified Split

Showing with 101 additions and 7 deletions.

+47 −0 bower.json

+0 −3 docs/README.md

+54 −4 docs/setup/project-setup.md

0 docs/setup/using_es6.md

0 docs/setup/using_script.md

0 docs/setup/using_typescript.md
@@ -0,0 +1,47 @@
+{
+  "name": "searchkit",
+  "description": "A suite of react components to help create a UI quickly for elasticsearch",
+  "main": [
+    "release/bundle.js",
+    "release/styles.css"
+  ],
+  "dependencies": {
+  },
+  "devDependencies": {
+  },
+  "moduleType": [
+    "amd",
+    "globals",
+    "node"
+  ],
+  "keywords": [
+    "elasticsearch",
+    "elastic search",
+    "react",
+    "ui components",
+    "search",
+    "library",
+    "client-side",
+    "widgets",
+    "react components"
+  ],
+  "authors": [
+    {
+      "name": "Joseph McElroy",
+      "email": "phoey1@gmail.com"
+    },
+    {
+      "name": "Siavash Etemadieh",
+      "email": "ssetem@gmail.com"
+    }
+  ],
+  "license": "MIT",
+  "ignore": [
+    "**/.*",
+    "node_modules",
+    "bower_components",
+    "test",
+    "tests"
+  ],
+  "private": true
+}
@@ -2,9 +2,6 @@
 
 * [Getting Started](/docs/setup/README.md)
   * [Project Setup](/docs/setup/project-setup.md)
-    * [Using typescript](/docs/setup/using_typescript.md)
-    * [Using es6](/docs/setup/using_es6.md)
-    * [Using script](/docs/setup/using_script.md)
   * [Connecting Elasticsearch](/docs/setup/elasticsearch.md)
   * [Indexing](/docs/setup/indexing.md)
   * [Using components](/docs/setup/using-components.md)
@@ -1,6 +1,56 @@
 # Project Setup
-Our recommended project setup is using webpack and typescript. We also support using searchkit with ES6 / Webpack and using normal library script file.
+Our recommended project setup is using webpack and typescript. We also support using searchkit with ES6 / Webpack and using normal library script file. Installing via NPM is recommended.
 
-* [Typescript, Webpack](/docs/setup/using_typescript.md)
-* [Javascript ES6 (Babel), Webpack](/docs/setup/using_es6.md)
-* [Script library](/docs/setup/using_script.md)
+## Using Module
+We recommend using webpack for module dependency management of Searchkit's src, css and static assets. requires scss, file loaders to properly resolve searchkit dependencies. See [searchkit webpack boilerplate](www.github.com/searchkit/searchkit-webpack-boilerplate).
+
+### Installing via NPM
+Searchkit is available on [npm](http://npmjs.com/package/searchkit). Searchkit is build on typescript so typescript definition files are available.
+
+```sh
+  npm install searchkit --save
+```
+
+### Importing with webpack / ES6
+
+```js
+
+import {
+	SearchBox,
+	RefinementListFilter,
+	Hits,
+	HitsStats,
+	Searcher,
+	SearcherProvider,
+	SearchkitComponent,
+	SelectedFilters,
+	MenuFilter,
+	HierarchicalMenuFilter,
+	Pagination,
+	ResetFilters
+	} from "searchkit";
+
+```
+
+## Using library script
+Searchkit library script is available from bower or from jsdelivr CDN.
+
+### Installing via bower
+Requires React, ReactDOM to be included before searchkit. Within the release folder, the src `bundle.js`, the css `styles.css` and static file assets.
+
+```sh
+  bower install searchkit --save
+```
+
+### CDN Script include
+
+```html
+  <script type="text/javascript" src="//cdn.jsdelivr.net/react/0.14.5/react.min.js"></script>
+  <script type="text/javascript" src="//cdn.jsdelivr.net/react/0.14.5/react-dom.min.js"></script>
+  <script type="text/javascript" src="//cdn.jsdelivr.net/searchkit/latest/bundle.js"></script>
+  <link rel="stylesheet" type="text/css" href="//cdn.jsdelivr.net/searchkit/latest/styles.css">
+```
+
+### Use
+
+[](codepen://searchkit/vLgLOw?height=800&defaultTab=js)