Skip to content

Commit

Permalink
Update documantation
Browse files Browse the repository at this point in the history
  • Loading branch information
almasaeed2010 committed Oct 10, 2013
1 parent 7ca51f0 commit f8f5f43
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,22 +8,31 @@ CI_AuthLTE is a light authentication library for codeigniter 2.x.
Dependencies
============
PHP 5.3 or higher

Codeigniter 2.x or higher

MySQL database

Main Features
=============
1- PHPass for password encryption

2- Limited login attempts

3- Secured "remember me" with limited time period

4- Forgetton password help

5- Optional activation email

6- Groups and priviledges control

7- Simple database structure

Documentation
=============
Installation:

Add the files to the corresponding directories. Then, dump the sql file to your database.
Open the auth_model.php file which is located in the Application/models directory. Make sure to edit the settings to match your desire.

Expand All @@ -33,6 +42,7 @@ $this->load->model('auth_model');
```

Creating an account:

To create an account simply use the create_account() function. Example:
```PHP
$user_id = $this->auth_model->create_account($email, $password);
Expand All @@ -48,6 +58,7 @@ $user_id = $this->auth_model->create_account($email, $password, NULL, $custom_da
If you want the account to be connected to a group, add the group id as a 3rd paramater.

Logging In:

Log a user in using the login() function. Example:
```PHP
$this->auth_model->login($email, $password, $remember_me = FALSE);
Expand Down

0 comments on commit f8f5f43

Please sign in to comment.