Merge pull request #6 from sasezaki/license-file

Add License file, & improve README

LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2023 struggle-for-php
+
+Permission is hereby granted, free of charge, to any person obtaining a copy 
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights 
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 
+copies of the Software, and to permit persons to whom the Software is 
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in 
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -7,6 +7,11 @@ This repository is aimed for used by these.
  - https://github.com/struggle-for-php/sfp-phpstan-psr-log
 
 But, You can use this for individual purpose.
+Add the following files to your stub settings.
+```
+stubs-for-throwable/LoggerInterface.phpstub
+stubs-for-throwable/AbstractLogger.phpstub
+```
 
 ## Features
 
@@ -36,6 +41,13 @@ https://groups.google.com/g/php-fig/c/nnwDWSFmij8
 
 ### `level` parameter of `log` method is a constant enum of LogLevels::*.
 
+```php
+/**
+ * @param LogLevel::*  $level
+ */
+public function log($level, $message, array $context = array())
+```
+
 ## Not Support (Not planned)
 
 - Stub `LoggerAwareTrait` with @psalm-require-implements

composer.json

@@ -1,7 +1,7 @@
 {
     "name": "struggle-for-php/sfp-stubs-psr-log",
     "description": "Stubs to let Static Analysis understand psr/log (PSR-3)",
-    "keywords": ["stub", "static analysis", "static-analysis", "psr3"],
+    "keywords": ["stub", "stubs", "static analysis", "static-analysis", "psr3", "log", "exception"],
     "type": "library",
     "license": "MIT",
     "authors": [