diff --git a/NOTICE b/NOTICE new file mode 100644 index 0000000..2b8d96f --- /dev/null +++ b/NOTICE @@ -0,0 +1,69 @@ +![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/cresteem/HawK-JS/test.yaml?branch=main&style=flat&logo=github&logoColor=black&logoSize=auto&label=Test&labelColor=white&color=rgb(80%2C200%2C10)) + + +Available on NPM: + +![NPM Version](https://img.shields.io/npm/v/%40cresteem%2Fhawk-js?style=flat&logo=rocket&logoColor=black&logoSize=auto&label=Richie%20JS%20Version&labelColor=white) + + +![NPM Downloads](https://img.shields.io/npm/d18m/%40cresteem%2Fhawk-js?style=flat&logo=rocket&logoColor=black&logoSize=auto&label=Download%20Counts&labelColor=white&color=rgb(80,200,10)) + + +## 🧑đŸģ Maintainer +[@iamspdarsan](https://github.com/iamspdarsan) - [LinkedIN](https://in.linkedin.com/in/iamspdarsan) - [Github](https://github.com/iamspdarsan) + +## ⚖ī¸ License + +HAWK JS Š 2024 by 🚀[CRESTEEM](https://www.cresteem.com/) is licensed under [APACHE LICENSE VERSION 2.0](https://www.apache.org/licenses/LICENSE-2.0.txt) + +## 💁đŸģ Contribution + +By contributing to this project, you agree that your contributions will be licensed under the Apache License, Version 2.0. You can find the full text of the license in the LICENSE file located in the root directory of this project. + +For more about contribution check [CONTRIBUTING](./CONTRIBUTING) file. + +### Šī¸ Attribution Requirements + +In addition to the terms of the Apache License, Version 2.0, you are required to provide the following attribution in any use, reproduction, and distribution of this software: + +"This software includes HAWK JS Š 2024 by [CRESTEEM](https://www.cresteem.com/). Licensed under the Apache License, Version 2.0." + +This attribution must be displayed in a prominent location in any documentation, notices, or marketing materials accompanying the distribution or use of this software. + +## Installation +```bash +yarn add @cresteem/richie-js + +or + +npm i @cresteem/richie-js +``` + +## 👨đŸģ‍đŸ’ģ CLI + +```bash +hawk -s indexnow + +or + +hawk -s gindex + +or + +hawk -s gwebmaster + +or + +hawk -s gwebmaster2 +``` + +[learn more about Hawk JS](https://www.cresteem.com/opensource/hawk-js) + +## 🌐 Documenation Website +[https://www.cresteem.com/opensource/hawk-js](https://www.cresteem.com/opensource/hawk-js) + +## References + +- https://www.robotstxt.org/ +- https://www.sitemaps.org/protocol.html +- https://developers.google.com/search/docs/crawling-indexing/sitemaps/build-sitemap