From c7c764a34fe0f2272105612c750f6436db0894e3 Mon Sep 17 00:00:00 2001 From: Keagan Date: Sat, 20 Jan 2024 12:14:53 +0100 Subject: [PATCH 1/2] Add a license and fix the readme file --- LICENSE | 16 ++++++++++++++++ README.md | 48 ++++++++++++++++++++++++++++++----------------- package-lock.json | 4 ++-- package.json | 4 ++-- 4 files changed, 51 insertions(+), 21 deletions(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..cead5c9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,16 @@ +MIT License + +Copyright (c) 2024 Quickdevelopment + +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. \ No newline at end of file diff --git a/README.md b/README.md index e0053ed..4d8542c 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,20 @@ -# WP-JS - -Get all your public WordPress data through the WP API using a tree-shakable TypeScript library. - -## Pre-requisites -- Make sure your WordPress site has the WP REST API enabled. -- It can cause CORS issues if you're using a local WordPress site. +
+

@quickdevelopment/wp-js · npm version

+

+ Get all your public WordPress data through the WP API using a tree-shakable TypeScript library. +

+
+ +
+ Table of Contents +
    +
  1. Installation
    2. +
  2. Usage
    3. +
  3. Coming up
    4. +
  4. Contributing
    5. +
  5. License
    6. +
+
## Installation ``` @@ -32,7 +42,7 @@ import {Post, PostDataType} from "@quickdevelopment/wp-js"; const posts = new Post() -posts.fetch().then((posts: PostDataType[]) => { +posts.fetchMany().then((posts: PostDataType[]) => { console.log(posts); }) .catch((err) => { @@ -47,7 +57,7 @@ import {User, UserDataType} from "@quickdevelopment/wp-js"; const user = new User(116) -user.fetch().then((user: UserDataType[]) => { +user.fetchMany().then((user: UserDataType[]) => { console.log(user); }) .catch((err) => { @@ -69,20 +79,24 @@ class CustomEndpoint extends WPJSBase { public fetch(): Promise { return this.get(); } + + public fetchMany(): Promise { + return this.get(); + } } ``` ## Coming up -- [ ] Add more API classes to retrieve data from the WP API +- [x] Add more API classes to retrieve data from the WP API - [ ] Examples of how to use the library in multiple contexts - [ ] Add a documentation site -## Issues -If you find any issues with the library, please create an issue on the GitHub repository. +## Contributing +If you want to contribute to this project, see [CONTRIBUTING](CONTRIBUTING) for details. -| Known Issues | Status | -|--------------|--------| -| | | +## License +MIT © Quickdevelopment. See [LICENSE](LICENSE) for details. -## Contributing -If you want to contribute to this project, please read the CONTRIBUTING.md file. \ No newline at end of file + +[coveralls-image]:https://coveralls.io/repos/github/quickdevelopment/wp-js/badge.svg?branch=main +[coveralls-url]:https://coveralls.io/github/quickdevelopment/wp-js?branch=main \ No newline at end of file diff --git a/package-lock.json b/package-lock.json index 435ee67..ee09eb4 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@quickdevelopment/wp-js", - "version": "3.0.0", + "version": "3.0.1", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "@quickdevelopment/wp-js", - "version": "3.0.0", + "version": "3.0.1", "license": "MIT", "devDependencies": { "@types/node": "^20.11.0", diff --git a/package.json b/package.json index bd93811..f0b0b3a 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "@quickdevelopment/wp-js", "private": false, - "version": "3.0.0", + "version": "3.0.1", "repository": "https://github.com/QuickDevelopment/wp-js", "author": "QuickDevelopment", "license": "MIT", @@ -38,7 +38,7 @@ "build": "tsc && vite build", "build:watch": "tsc && vite build --watch", "preview": "vite preview", - "prepublishOnly": "npm run build", + "prepublishOnly": "npm run lint && npm run build", "lint": "npx eslint ." }, "devDependencies": { From eddf021481f22a5a8d4d26d78b44bfa09633ce48 Mon Sep 17 00:00:00 2001 From: Keagan Date: Sat, 20 Jan 2024 12:16:09 +0100 Subject: [PATCH 2/2] Remove the "what version?" --- .github/ISSUE_TEMPLATE/1-bug-report.yml | 13 ------------- 1 file changed, 13 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/1-bug-report.yml b/.github/ISSUE_TEMPLATE/1-bug-report.yml index 51c3198..4987521 100644 --- a/.github/ISSUE_TEMPLATE/1-bug-report.yml +++ b/.github/ISSUE_TEMPLATE/1-bug-report.yml @@ -20,19 +20,6 @@ body: value: "Please describe the problem you are having. Include any relevant log output, if applicable." validations: required: true - - type: dropdown - id: version - attributes: - label: Version - description: What version of our software are you running? - options: - - 1.0.0 - - 2.0.0 - - 2.0.5 - - 3.0.0 - default: 3 - validations: - required: true - type: textarea id: logs attributes: