Skip to content

Commit 6418f68

Browse files
committed
Add table of contents, donate section
1 parent 2af4c6b commit 6418f68

File tree

1 file changed

+26
-2
lines changed

1 file changed

+26
-2
lines changed

readme.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,19 @@ A MySQL session store for [express.js](http://expressjs.com/).
44

55
[![Build Status](https://travis-ci.org/chill117/express-mysql-session.svg?branch=master)](https://travis-ci.org/chill117/express-mysql-session)
66

7+
* [Installation](#installation)
8+
* [Important Notes](#important-notes)
9+
* [Older Versions](#older-versions)
10+
* [Session Table Collation](#session-table-collation)
11+
* [Usage](#usage)
12+
* [Debugging](#debugging)
13+
* [Contributing](#contributing)
14+
* [Configure Local Environment](#configure-local-environment)
15+
* [Tests](#tests)
16+
* [Changelog](#changelog)
17+
* [License](#license)
18+
* [Donate](#donate)
19+
720

821
## Installation
922

@@ -27,7 +40,7 @@ For users who are still using express-mysql-session `0.x`. Changes have been mad
2740
This module creates a database table to save session data. This data is stored in a MySQL text field with the [utf8mb4](https://dev.mysql.com/doc/refman/5.5/en/charset-unicode-utf8mb4.html) collation - added in [MySQL 5.5.3](https://dev.mysql.com/doc/relnotes/mysql/5.5/en/news-5-5-3.html). The reason for this is to fully support the utf8 character set. If you absolutely must use an older version of MySQL, create your sessions table before initializing the `MySQLStore`.
2841

2942

30-
## How to Use
43+
## Usage
3144

3245
Use with your express session middleware, like this:
3346
```js
@@ -222,7 +235,7 @@ DB_NAME="session_test"
222235
```
223236

224237

225-
### Running Tests
238+
### Tests
226239

227240
To run all tests:
228241
```
@@ -233,3 +246,14 @@ npm test
233246
## Changelog
234247

235248
See [changelog.md](https://github.com/chill117/express-mysql-session/blob/master/changelog.md)
249+
250+
251+
## License
252+
253+
This software is [MIT licensed](https://tldrlegal.com/license/mit-license):
254+
> A short, permissive software license. Basically, you can do whatever you want as long as you include the original copyright and license notice in any copy of the software/source. There are many variations of this license in use.
255+
256+
257+
## Donate
258+
259+
This project is free and open-source. If you would like to show your appreciation by making a donation, you can find details about which options are available [here](https://degreesofzero.com/donate.html).

0 commit comments

Comments
 (0)