Fix typo, update docs

machour · Aug 31, 2017 · d21a02b · d21a02b
1 parent 5242953
commit d21a02b
Show file tree

Hide file tree

Showing 6 changed files with 7 additions and 5 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,6 @@
 composer.phar
 vendor/
+.idea
 
 # Commit your application's lock file http://getcomposer.org/doc/01-basic-usage.md#composer-lock-the-lock-file
 # You may choose to ignore a library lock file http://getcomposer.org/doc/02-libraries.md#lock-file

diff --git a/README.md b/README.md
@@ -13,5 +13,5 @@ This module will install it's own table, and quickly allow you to:
 
 ![Growl notification](docs/main.png)
 
-A documentation is available in the [docs](docs/TOC.md) folder of this repository.
+A documentation is available in the [docs](docs/README.md) folder of this repository.
 You can also check this [live demo](https://machour.idk.tn/yii2-kitchen-sink/site/yii2-notifications).
diff --git a/commands/NotificationsController.php b/commands/NotificationsController.php
@@ -25,6 +25,6 @@ public function actionClean()
 
 		$records_deleted = $class::deleteAll($criteria);
 
-		echo "$records_deleted obselete notifications removed\n";
+		echo "$records_deleted obsolete notifications removed\n";
 	}
 }
diff --git a/docs/Contributors.md b/docs/Contributors.md
@@ -1,4 +1,3 @@
-
 Contributors
 ------------
 

diff --git a/docs/Installation.md b/docs/Installation.md
@@ -6,13 +6,13 @@ The preferred way to install this extension is through [composer](http://getcomp
 Either run
 
 ```
-php composer.phar require --prefer-dist machour/yii2-notifications "@dev"
+php composer.phar require machour/yii2-notifications "*"
 ```
 
 or add
 
 ```
-"machour/yii2-notifications": "@dev"
+"machour/yii2-notifications": "*"
 ```
 
 to the require section of your `composer.json` file.
diff --git a/docs/TOC.md → docs/README.md b/docs/TOC.md → docs/README.md
@@ -1,3 +1,5 @@
+# yii2-notifications documentation
+
 * [Installation](Installation.md)
 * [Concept](Concept.md)
 * [Configuration](Configuration.md)