better readme

Author: smknstd

LICENSE

@@ -0,0 +1,22 @@
+
+The MIT License (MIT)
+
+Copyright (c) 2018 GitHub, Inc. and contributors
+
+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

@@ -1,8 +1,22 @@
+# Detect Laravel Ray
+This GitHub Action allows you to scan Laravel application codebase and detects remaining [Spatie's ray](https://myray.app/) calls. By default, it includes the following directories:
+- ./app
+- ./resources/views
+- ./database
+- ./routes
+- ./tests
 
-## Releasing
+## Usage
 
-To release new version of this package:
-```bash
-git tag -f v1
-git push -f origin v1
+```yaml
+- name: Detect remaining Spatie\ray calls
+  uses: code16/x-ray-action@v1
 ```
+
+## License
+
+The scripts and documentation in this project are released under the [MIT License](LICENSE)
+
+## Contributing
+
+Please feel free to create an issue if you find a bug or send a pull request if you wish to improve the existing code/add a new feature. 

action.yml

@@ -1,5 +1,5 @@
-name: 'Check ray cals'
-description: 'Fail the current workflow if there is a "ray()" in the code'
+name: 'Detect remaining Spatie\ray calls in a Laravel application'
+description: 'Fail the current workflow if there is a "ray()" or "@ray()" in the code'
 #inputs:
 #  who-to-greet:  # id of input
 #    description: 'Who to greet'