Skip to content

Commit 70499ff

Browse files
committed
Update README for 2.0
1 parent 8c04f79 commit 70499ff

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ Lightweight user alerts for CodeIgniter 4
77
## Quick Start
88

99
1. Run: `> composer require tatter/alerts`
10-
2. Load the helper: `helper("tatter\alerts");`
10+
2. Load the helper: `helper('alerts');`
1111
2. Set an alert: `alert('success', "You did it!")`
12-
3. Add in head tag (optional): `<?= alertsCss(); ?>`
13-
4. Add after banner/menu: `<?= alerts(); ?>`
12+
3. Add in head tag (optional): `<?= service('alerts')->css(); ?>`
13+
4. Add after banner/menu: `<?= service('alerts')->display(); ?>`
1414

1515
## Features
1616

@@ -33,15 +33,15 @@ comments. If no config file is found the library will use its defaults.
3333

3434
## Usage
3535

36-
If installed correctly CodeIgniter 4 will detect and autoload the library, helper, and
37-
(optional) config. Initialize the helper before using its functions:
36+
If installed correctly CodeIgniter 4 will detect and autoload the library, service, helper,
37+
and config. Initialize the helper if you want the convenience wrapper function:
3838
`helper("tatter\alerts");`
3939

4040
Then use the helper function `alert($class, $text)` to set an alert for the user's next
41-
view. Use helper functions `alertCss()` and `alerts()` to retrieve the styling and HTML
42-
for the alerts.
41+
view. Use class methods `$alerts->css()` and `$alerts->display()` to retrieve the styling
42+
and HTML for the alerts.
4343

4444
## Styles
4545

4646
By default alerts will be displayed with classes for Bootstrap. Styles can be changed
47-
to other toolkits (or may use your own) by altering the settings in the config file.
47+
to other toolkits (or you may use your own) by altering the settings in the config file.

0 commit comments

Comments
 (0)