Merge pull request #30 from kha7iq/update-docs

update documentation

CONTRIBUTING.md

@@ -67,9 +67,8 @@ We actively welcome your pull requests.
 1. Fork the repo and create your branch from `master`.
 2. If you've added code that should be tested, add tests.
 3. If you've changed APIs, update the documentation.
-4. Ensure the test suite passes (`make test`).
+4. Make sure your code lints (`make lint`).
-5. Make sure your code lints (`make lint`).
+5. Make sure your code is well formatted (`make fmt`).
-6. Make sure your code is well formatted (`make fmt`).
 
 ## Issues
 

LICENSE.md

@@ -1,7 +1,7 @@
 <!-- markdownlint-disable MD041 -->
 MIT License
 
-Copyright (c) 2021 Khaliq
+Copyright (c) 2021 Abdul Khaliq <a.khaliq@outlook.my>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -127,6 +127,10 @@ docker run ghcr.io/kha7iq/pingme:latest
 A github action is also available now for this app, you can find it on
 [Github Market Place](https://github.com/marketplace/actions/pingme-action) or
 from this [repository](https://github.com/kha7iq/pingme-action) on github.
+```yaml
+- name: PingMe-Action
+  uses: kha7iq/pingme-action@v1
+```
 
 Usage examples for workflow are available in the repo.