Skip to content

Commit 4d2910f

Browse files
author
edvler
committed
Updated documentation
1 parent b24aafb commit 4d2910f

File tree

1 file changed

+36
-19
lines changed

1 file changed

+36
-19
lines changed

readme.md

Lines changed: 36 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,25 @@
55
[![Latest Stable Version](https://poser.pugx.org/edvlerblog/yii2-adldap-module/v/stable)](https://packagist.org/packages/edvlerblog/yii2-adldap-module)
66
[![Total Downloads](https://poser.pugx.org/edvlerblog/yii2-adldap-module/downloads)](https://packagist.org/packages/edvlerblog/yii2-adldap-module)
77
[![Monthly Downloads](https://poser.pugx.org/edvlerblog/yii2-adldap-module/d/monthly)](https://packagist.org/packages/edvlerblog/yii2-adldap-module)
8+
[![Daily Downloads](https://poser.pugx.org/edvlerblog/yii2-adldap-module/d/daily)](https://packagist.org/packages/edvlerblog/yii2-adldap-module)
89
[![License](https://poser.pugx.org/phpunit/phpunit/license)](https://packagist.org/packages/edvlerblog/yii2-adldap-module)
910

11+
## List of content
12+
* **Overview**
13+
* [Version](#version)
14+
* [Functions of the extension](#functions-of-the-extension)
15+
16+
* **Installation and configuration**
17+
* [Installation](#installation)
18+
* [Configuration](#configuration)
19+
20+
* **Usage Methods**
21+
* [Method 1](#usage-method-1-simple-usage-without-a-user-model)
22+
* [Method 2](#usage-method-2-deep-integration-into-the-yii2-framework-with-a-user-model)
23+
24+
* **For developers**
25+
* [Testing](#testing)
26+
1027
## Version
1128

1229
Current Version:
@@ -15,22 +32,7 @@ The corresponding Adldap2 repository is https://github.com/Adldap2/Adldap2/tree/
1532

1633
**Keep this in mind if you are browsing the GitHub Repository of Adldap2**
1734

18-
19-
## Installation
20-
21-
The preferred way to install this extension is through [Composer](http://getcomposer.org/).
22-
23-
Either run
24-
```
25-
php composer.phar require edvlerblog/yii2-adldap-module "^3.0.0"
26-
```
27-
or add
28-
```
29-
"edvlerblog/yii2-adldap-module": "^3.0.0"
30-
```
31-
to the require section of your composer.json
32-
33-
## Functions of the Plugin!
35+
## Functions of the extension
3436
It has been a long way since 29. Jan 2014, many functions has been added. I noticed for myself that a short overview might help everyone to see whats possible.
3537

3638
**The simple [Method 1](#usage-method-1-simple-usage-without-a-user-model)**
@@ -54,6 +56,19 @@ It has been a long way since 29. Jan 2014, many functions has been added. I noti
5456
* [Method 2: docs/USAGE_WITH_USER_MODEL.md](docs/USAGE_WITH_USER_MODEL.md)
5557
* You can try to contanct me! If I find time, I would answer your questions!
5658

59+
## Installation
60+
61+
The preferred way to install this extension is through [Composer](http://getcomposer.org/).
62+
63+
Either run
64+
```
65+
php composer.phar require edvlerblog/yii2-adldap-module "^3.0.0"
66+
```
67+
or add
68+
```
69+
"edvlerblog/yii2-adldap-module": "^3.0.0"
70+
```
71+
to the require section of your composer.json
5772

5873
## Configuration
5974

@@ -207,7 +222,7 @@ echo '<pre>' . print_r($ldapObject,true) . '</pre>';
207222
//...
208223
```
209224

210-
**Further Documentation with examples:** [docs/USAGE_WITHOUT_USER_MODEL.md](docs/USAGE_WITHOUT_USER_MODEL.md)
225+
**Further documentation with examples:** [docs/USAGE_WITHOUT_USER_MODEL.md](docs/USAGE_WITHOUT_USER_MODEL.md)
211226

212227
---
213228

@@ -263,11 +278,13 @@ For example imagine the following:
263278
If you try to login with your new user, the user is created **automatically** in yii2 and role yii2_example_group is assigned **automatically** on login.
264279
For the user this is transparent. The only feedback to the user is a successull login and that it is possible to use the functions which he has permissions to access.
265280

266-
**Further Documentation with setup and examples:** [docs/USAGE_WITH_USER_MODEL.md](docs/USAGE_WITH_USER_MODEL.md)
281+
**Further documentation with setup and examples:** [docs/USAGE_WITH_USER_MODEL.md](docs/USAGE_WITH_USER_MODEL.md)
282+
267283

268284

285+
### Testing
286+
This section is only for users, that may extend the functionality.
269287

270-
### Unit-Tests: Not needed for normal users of the yii2-adldap-module
271288
There exists two Unit-Tests.
272289
- One for Method 1: tests/SimpleUsageTest.php
273290
- One for Method 2: tests/UserModelTest.php

0 commit comments

Comments
 (0)