Skip to content

Commit 725149a

Browse files
committed
update readme
1 parent 4c61c51 commit 725149a

File tree

3 files changed

+51
-56
lines changed

3 files changed

+51
-56
lines changed

README.md

Lines changed: 0 additions & 56 deletions
This file was deleted.

docs/README.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Shapecode - Doctrine Session Handler Bundle
2+
3+
[![paypal](https://img.shields.io/badge/Donate-Paypal-blue.svg)](http://paypal.me/nloges)
4+
5+
[![PHP Version](https://img.shields.io/packagist/php-v/shapecode/doctrine-session-handler-bundle.svg)](https://packagist.org/packages/shapecode/doctrine-session-handler-bundle)
6+
[![Latest Stable Version](https://img.shields.io/packagist/v/shapecode/doctrine-session-handler-bundle.svg?label=stable)](https://packagist.org/packages/shapecode/doctrine-session-handler-bundle)
7+
[![Latest Unstable Version](https://img.shields.io/packagist/vpre/shapecode/doctrine-session-handler-bundle.svg?label=unstable)](https://packagist.org/packages/shapecode/doctrine-session-handler-bundle)
8+
[![Total Downloads](https://img.shields.io/packagist/dt/shapecode/doctrine-session-handler-bundle.svg)](https://packagist.org/packages/shapecode/doctrine-session-handler-bundle)
9+
[![Monthly Downloads](https://img.shields.io/packagist/dm/shapecode/doctrine-session-handler-bundle.svg)](https://packagist.org/packages/shapecode/doctrine-session-handler-bundle)
10+
[![Daily Downloads](https://img.shields.io/packagist/dd/shapecode/doctrine-session-handler-bundle.svg)](https://packagist.org/packages/shapecode/doctrine-session-handler-bundle)
11+
[![License](https://img.shields.io/packagist/l/shapecode/doctrine-session-handler-bundle.svg)](https://packagist.org/packages/shapecode/doctrine-session-handler-bundle)
12+
13+
This bundle provides a Doctrine session handler to save sessions in a database.
14+
15+
## Install instructions
16+
17+
Installing this bundle can be done through these simple steps:
18+
19+
Add the bundle to your project as a composer dependency:
20+
21+
```bash
22+
$ composer require shapecode/doctrine-session-handler-bundle
23+
```
24+
25+
Add the bundle to your bundles.php:
26+
```php
27+
<?php
28+
29+
return [
30+
// ...
31+
Shapecode\Bundle\Doctrine\SessionHandlerBundle\ShapecodeDoctrineSessionHandlerBundle::class => ['all' => true],
32+
// ...
33+
];
34+
```
35+
36+
Update your database.
37+
38+
```bash
39+
$ php bin/console doctrine:schema:update --force
40+
```
41+
42+
Now you have to change your application config (default location of app/config/packages/framework.yaml).
43+
44+
```yml
45+
framework:
46+
session:
47+
handler_id: Shapecode\Bundle\Doctrine\SessionHandlerBundle\Session\Handler\DoctrineHandler
48+
```
49+
50+
Done ;)

docs/_config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
theme: jekyll-theme-cayman

0 commit comments

Comments
 (0)