docs: add readme for get-works [skip ci]

aminya · Aug 8, 2022 · 1df74e7 · 1df74e7
1 parent 4d3cf92
commit 1df74e7
Show file tree

Hide file tree

Showing 4 changed files with 40 additions and 0 deletions.
diff --git a/packages/get-works/README.md b/packages/get-works/README.md
@@ -0,0 +1,40 @@
+<h1 align="center">get-works</h1>
+<p>
+  <img alt="Version" src="https://img.shields.io/badge/version-1.0.0-blue.svg?cacheSeconds=2592000" />
+  <a href="#" target="_blank">
+    <img alt="License: Apache--2.0" src="https://img.shields.io/badge/License-Apache--2.0-yellow.svg" />
+  </a>
+</p>
+
+> Check if the GET request for the given URL works
+
+## Install
+
+```sh
+npm install --save get-works
+```
+
+## Usage
+
+<!-- INSERT GENERATED DOCS START -->
+
+### `getWorks` (function)
+
+Check if the GET request for the given URL works
+
+**Parameters:**
+
+- url (`string`) - The given URL
+
+**returns:** Promise<boolean>
+
+<!-- INSERT GENERATED DOCS END -->
+
+## 🤝 Contributing
+
+You can sponsor my work here:
+
+https://github.com/sponsors/aminya
+
+Pull requests, issues and feature requests are welcome.
+See the [Contributing guide](https://github.com/aminya/setup-cpp/blob/master/CONTRIBUTING.md).
diff --git a/packages/ok-status/package.json → packages/get-works/package.json b/packages/ok-status/package.json → packages/get-works/package.json
diff --git a/packages/ok-status/src/index.ts → packages/get-works/src/index.ts b/packages/ok-status/src/index.ts → packages/get-works/src/index.ts
diff --git a/packages/ok-status/tsconfig.json → packages/get-works/tsconfig.json b/packages/ok-status/tsconfig.json → packages/get-works/tsconfig.json