Merge branch 'release/1.0.6'

CHANGELOG.md

@@ -1,3 +1,18 @@
+<a name="1.0.6"></a>
+## [1.0.6](https://github.com/adonisjs/adonis-session/compare/v1.0.5...v1.0.6) (2017-08-01)
+
+
+### Features
+
+* **instructions:** add instructions file for ace ([959d3ce](https://github.com/adonisjs/adonis-session/commit/959d3ce))
+
+
+### Reverts
+
+* **command:** remove config:session command ([3387118](https://github.com/adonisjs/adonis-session/commit/3387118))
+
+
+
 <a name="1.0.5"></a>
 ## [1.0.5](https://github.com/adonisjs/adonis-session/compare/v1.0.4...v1.0.5) (2017-07-31)
 

instructions.js

@@ -0,0 +1,20 @@
+'use strict'
+
+/*
+ * adonis-session
+ *
+ * (c) Harminder Virk <virk@adonisjs.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+*/
+
+const path = require('path')
+
+module.exports = async function (cli) {
+  try {
+    await cli.makeConfig('session.js', path.join(__dirname, './templates/config.mustache'))
+  } catch (error) {
+    // ignore if session.js already exists
+  }
+}

instructions.md

@@ -0,0 +1,34 @@
+## Registering provider
+
+Make sure to register the provider before you can make use of sessions. The providers are registered inside `start/app.js` file.
+
+```js
+const providers = [
+  '@adonisjs/session/providers/SessionProvider'
+]
+```
+
+## Registering middleware
+
+The next thing you should do is register the global middleware inside `start/kernel.js` file.
+
+```js
+const globalMiddleware = [
+  'Adonis/Middleware/Session'
+]
+```
+
+## Using session
+
+Once done with provider and middleware registeration, you can make use of the session by grabbing an instance from the HTTP request context.
+
+```js
+Route.get('/', async ({ session }) => {
+  session.get('username')
+  session.put('username', 'virk')
+})
+```
+
+## Config
+
+You can find the configuration inside `config/session.js` file. Feel free to tweak it as per your needs.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adonisjs/session",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "This repo is the official session provider for Adonisjs apps. It supports multiple drivers to store session data.",
   "main": "providers/SessionProvider",
   "directories": {