Skip to content

Commit 3f763b2

Browse files
committed
fixed typos in README
1 parent 7ad0f89 commit 3f763b2

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ If you are using [Cloudant](https://cloudant.com), then your databases are secur
180180

181181
If, however, you are using regular CouchDB, then Admin Party is default and all your databases are readable and writable by the public until you implement the correct security measures. It is your responsibility to study up on [best security practices](http://blog.mattwoodward.com/2012/03/definitive-guide-to-couchdb.html) and apply them. To block anonymous reads across all databases you can set `require_valid_user` to `true` under `[couch_httpd_auth]` in your CouchDB config.
182182

183-
SuperLogin also allows you to specify default `_security` roles for members and admins in the `userDBs` section of your config file. See `[config.example.js](https://github.com/colinskow/superlogin/blob/master/config.example.js)` for details.
183+
SuperLogin also allows you to specify default `_security` roles for members and admins in the `userDBs` section of your config file. See [`config.example.js`](https://github.com/colinskow/superlogin/blob/master/config.example.js) for details.
184184

185185
## Adding Providers
186186

@@ -237,7 +237,7 @@ Note that this uses the exact settings in your config as the popup window workfl
237237

238238
## Advanced Configuration
239239

240-
Take a look at `[config.example.js](https://github.com/colinskow/superlogin/blob/master/config.example.js)` for a complete tour of all available configuration options. You'll find a lot of cool hidden features there that aren't documented here.
240+
Take a look at [`config.example.js`](https://github.com/colinskow/superlogin/blob/master/config.example.js) for a complete tour of all available configuration options. You'll find a lot of cool hidden features there that aren't documented here.
241241

242242
`/config/default.config.js` contains a list of default settings that will be assumed if you don't specify anything.
243243

@@ -250,7 +250,7 @@ If you are using Cloudant authentication, the prefixed `user_id` is inserted as
250250
## Routes
251251

252252
##### `POST /register`
253-
Creates a new account with a username and password. Required fields are: `username`, `email`, `password` and `confirmPassword`. `name` is optional. Any additional fields you want to include need to be white listed under `userModel` in your config. See `[config.example.js](https://github.com/colinskow/superlogin/blob/master/config.example.js)` for details.
253+
Creates a new account with a username and password. Required fields are: `username`, `email`, `password` and `confirmPassword`. `name` is optional. Any additional fields you want to include need to be white listed under `userModel` in your config. See [`config.example.js`](https://github.com/colinskow/superlogin/blob/master/config.example.js) for details.
254254

255255
If `local.sendConfirmEmail` is true, a confirmation email will be sent with a verify link. If `local.requireEmailConfirm` is true, the user will not be able to login until the confirmation is complete. If `local.loginOnRegistration` is true a session will be automatically created and sent as the response.
256256

@@ -463,7 +463,7 @@ Deauthorizes every single expired session found in the user database.
463463
##### `superlogin.sendEmail(templateName, email, locals)`
464464
Renders an email and sends it out. Server settings are specified under `mailer` in your config.
465465

466-
* `templateName`: the name of a template object specified under `emails` in your config. See `[config.example.js](https://github.com/colinskow/superlogin/blob/master/config.example.js)` for details.
466+
* `templateName`: the name of a template object specified under `emails` in your config. See [`config.example.js`](https://github.com/colinskow/superlogin/blob/master/config.example.js) for details.
467467
* `email`: the email address that the email
468468
* `locals`: local variables that will be passed into the ejs template to be rendered
469469

0 commit comments

Comments
 (0)