Skip to content

Fixes to README documentation #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rmrhz wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fixes to README documentation #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ Easily protect against [CSRF](https://www.owasp.org/index.php/Cross-Site_Request
Installation
------------

This library is published on packagist. To install using Composer, add the `"athens/csrf": "0.1.*"` line to your "require" dependencies:
This library is published on packagist. To install using Composer, simply run `composer require athens/csrf` or add this line to your "require" dependencies:

```
{
"require": {
...
"athens/csrf": "1.*",
"athens/csrf": "2.*",
...
}
}
Expand All @@ -30,7 +30,7 @@ Use
---

Using this package requires only two lines:
```
```php
// Import the CSRF class
use Athens\CSRF\CSRF;

Expand All @@ -39,7 +39,7 @@ Using this package requires only two lines:
```

The method `::init()` will automatically insert a hidden CSRF token field into your forms:
```
```html
<!--output html-->
...
<form>
Expand All @@ -49,7 +49,7 @@ The method `::init()` will automatically insert a hidden CSRF token field into y
This token will be included automatically in any of your form submissions.

Incase you perform form submission via AJAX, `::init()` also inserts a `CSRF_TOKEN` variable into your javascript:
```
```html
<!--output html-->
...
<head>
Expand Down