From 90223634020a54eca9fc6f912e24db395f9f3416 Mon Sep 17 00:00:00 2001 From: hugoalh <32359235+hugoalh@users.noreply.github.com> Date: Mon, 12 Feb 2024 16:47:20 +0800 Subject: [PATCH] Update resources --- .../CODE_OF_CONDUCT.md | 0 CONTRIBUTING.md => .github/CONTRIBUTING.md | 0 .github/labels.yml | 29 +++++-------------- CITATION.cff | 13 +++++++++ README.md | 21 +------------- SECURITY.md | 23 +++++++-------- 6 files changed, 32 insertions(+), 54 deletions(-) rename CODE_OF_CONDUCT.md => .github/CODE_OF_CONDUCT.md (100%) rename CONTRIBUTING.md => .github/CONTRIBUTING.md (100%) create mode 100644 CITATION.cff diff --git a/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md similarity index 100% rename from CODE_OF_CONDUCT.md rename to .github/CODE_OF_CONDUCT.md diff --git a/CONTRIBUTING.md b/.github/CONTRIBUTING.md similarity index 100% rename from CONTRIBUTING.md rename to .github/CONTRIBUTING.md diff --git a/.github/labels.yml b/.github/labels.yml index 6f3b16c..fa37ffa 100644 --- a/.github/labels.yml +++ b/.github/labels.yml @@ -5,27 +5,24 @@ - name: "Platform/AssemblyScript" color: "#007AAC" description: "Related to AssemblyScript." +- name: "Platform/Bun" + color: "#F9F1E1" + description: "Related to Bun." - name: "Platform/ClamAV" color: "#B83033" description: "Related to ClamAV." -- name: "Platform/CodeFactor" - color: "#F44A6A" - description: "Related to CodeFactor." - name: "Platform/CodeQL" color: "#FFFFFF" - description: "Related to CodeQL (previous LGTM)." + description: "Related to CodeQL." - name: "Platform/Crowdin" color: "#2E3340" description: "Related to Crowdin." -- name: "Platform/CurseForge" - color: "#F16436" - description: "Related to CurseForge." - name: "Platform/Deno" color: "#000000" description: "Related to Deno." - name: "Platform/DenoNetwork" color: "#000000" - description: "Related to Deno Deploy, Deno KV, or Deno Module Registry." + description: "Related to Deno Deploy, Deno KV, Deno Land, or Deno Module Registry." - name: "Platform/Dependabot" color: "#025E8C" description: "Related to Dependabot." @@ -65,9 +62,6 @@ - name: "Platform/JavaScript" color: "#F7DF1E" description: "Related to JavaScript." -- name: "Platform/Kaspersky" - color: "#006D5C" - description: "Related to Kaspersky." - name: "Platform/Linux" color: "#FCC624" description: "Related to Linux." @@ -94,13 +88,10 @@ description: "Related to Microsoft Edge." - name: "Platform/Minecraft" color: "#62B47A" - description: "Related to Minecraft (previous Minecraft Bedrock)." + description: "Related to Minecraft (Bedrock)." - name: "Platform/MinecraftJava" color: "#62B47A" - description: "Related to Minecraft Java (previous Minecraft)." -- name: "Platform/MongoDB" - color: "#47A248" - description: "Related to MongoDB." + description: "Related to Minecraft Java." - name: "Platform/NodeJS" color: "#339933" description: "Related to NodeJS." @@ -119,12 +110,6 @@ - name: "Platform/Python" color: "#3776AB" description: "Related to Python." -- name: "Platform/Replit" - color: "#F26207" - description: "Related to Replit." -- name: "Platform/ReplitDatabase" - color: "#F26207" - description: "Related to Replit Database." - name: "Platform/Roblox" color: "#000000" description: "Related to Roblox." diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000..68209bb --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,13 @@ +# yaml-language-server: $schema=https://citation-file-format.github.io/1.2.0/schema.json +cff-version: "1.2.0" +title: "exFetch (NodeJS)" +message: "If you use this software, please cite it using the metadata from this file." +type: "software" +authors: + - name: "hugoalh Studio" +repository-code: "https://github.com/hugoalh-studio/exfetch-nodejs" +keywords: + - "exfetch" + - "fetch" + - "nodejs" +license: "MIT" diff --git a/README.md b/README.md index 83c9d96..cecaa34 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ # exFetch (NodeJS) [โš–๏ธ MIT](./LICENSE.md) -[![CodeFactor Grade](https://img.shields.io/codefactor/grade/github/hugoalh-studio/exfetch-nodejs?label=Grade&logo=codefactor&logoColor=ffffff&style=flat-square "CodeFactor Grade")](https://www.codefactor.io/repository/github/hugoalh-studio/exfetch-nodejs) | | **Release - Latest** | **Release - Pre** | |:-:|:-:|:-:| @@ -31,30 +30,12 @@ This project is inspired from: ## ๐Ÿ”ฐ Begin -### Bun - -> **๐Ÿงช Experimental:** Bun is still under development. - -- **Target Version:** ^ v1.0.0, &: - - TypeScript >= v5.1.0 *\[Development\]* -- **Require Permission:** *N/A* -- **Domain/Registry:** - - [NPM](https://www.npmjs.com/package/@hugoalh/exfetch) - ```sh - bun add @hugoalh/exfetch[@] - ``` - ```js - import ... from "@hugoalh/exfetch[@]"; - ``` - -> **โ„น๏ธ Notice:** It is also able to import part of the module with sub path if available, see [file `package.json`](./package.json) property `exports` for available sub paths. - ### NodeJS - **Target Version:** >= v18.12.0, &: - TypeScript >= v5.1.0 *\[Development\]* - **Require Permission:** *N/A* -- **Domain/Registry:** +- **Registry:** - [NPM](https://www.npmjs.com/package/@hugoalh/exfetch) ```sh npm install @hugoalh/exfetch[@] diff --git a/SECURITY.md b/SECURITY.md index 9a27f94..0ba3b0d 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -2,19 +2,18 @@ ## Supported Versions -> | **Support** | **Legend** | **Description** | -> |:-:|:-:|:--| -> | โœ”๏ธ | ๐ŸŸค | Pending / Pre Release / Unstable | -> | โœ”๏ธ | ๐Ÿ”ต | Current Release | -> | โœ”๏ธ | ๐ŸŸข | Long Term Support | -> | โœ”๏ธ | ๐ŸŸ  | Maintenance | -> | โŒ | ๐Ÿ”ด | End of Life | +> | **Legend** | **Description** | +> |:-:|:--| +> | ๐ŸŸค | Pending / Pre Release / Unstable | +> | ๐Ÿ”ต | Current Release | +> | ๐ŸŸข | Long Term Support | +> | ๐ŸŸ  | Maintenance | +> | ๐Ÿ”ด | End Of Life / Not Supported | -| **Versions** | **Status** | **๐Ÿ”ต Date** | **๐ŸŸข Date** | **๐Ÿ”ด Date** | **Target - Bun** | **Target - NodeJS** | -|:-:|:-:|:-:|:-:|:-:|:-:|:-:| -| v0.3.X | ๐Ÿ”ต | 2024-01-14 | *N/A* | *Unknown* | ^ v1.0.0 | >= v18.12.0 | -| v0.2.X | ๐ŸŸ  | 2023-11-16 | *N/A* | 2024-03-15 | ^ v1.0.0 | >= v18.0.0 | -| v0.1.X | ๐Ÿ”ด | 2023-11-03 | *N/A* | 2023-12-01 | ^ v1.0.0 | >= v18.0.0 | +| **Versions** | **Status** | **๐Ÿ”ต Date** | **๐ŸŸข Date** | **๐Ÿ”ด Date** | **Target - NodeJS** | +|:-:|:-:|:-:|:-:|:-:|:-:| +| v0.3.X | ๐Ÿ”ต | 2024-01-14 | *N/A* | *Unknown* | >= v18.12.0 | +| v0.2.X | ๐ŸŸ  | 2023-11-16 | *N/A* | 2024-03-15 | >= v18.0.0 | > **โ„น๏ธ Notice:** >