From 3bfa5e90d76f5037bed34c9caaa91673b18ef681 Mon Sep 17 00:00:00 2001 From: Wessel Tip Date: Fri, 12 Apr 2019 20:00:12 +0200 Subject: [PATCH] update docs --- .npmignore | 2 -- README.md | 93 ++------------------------------------------------- docs/logo.svg | 1 - 3 files changed, 3 insertions(+), 93 deletions(-) delete mode 100644 docs/logo.svg diff --git a/.npmignore b/.npmignore index 51cd914..b4d9fb5 100644 --- a/.npmignore +++ b/.npmignore @@ -1,10 +1,8 @@ dist/ -docs/ __test__/ examples/ node_modules/ -README.md yarn.lock index.d.ts .gitignore diff --git a/README.md b/README.md index 6389c15..d5d8337 100644 --- a/README.md +++ b/README.md @@ -8,105 +8,18 @@ Wumpfetch is a fast, lightweight and easy to use HTTP client for Node.JS. -> [`Typings`](https://github.com/PassTheWessel/wumpfetch-typings) **|** [`GitHub`](https://github.com/PassTheWessel/wumpfetch) **|** [`NPM`](https://npmjs.com/package/wumpfetch) +> [`GitHub`](https://github.com/PassTheWessel/wumpfetch) **|** [`NPM`](https://npmjs.com/package/wumpfetch)
## Installing -Wumpfetch can be installed with any package manager that supports the NPM registry, but the ones listed below are the most used ones. ```sh $ yarn add wumpfetch # Install w/ Yarn $ npm i wumpfetch # Install w/ NPM ``` -## Example usage -##### Code -```js -const w = require('wumpfetch'); - -;(async() => { - const r = await w('https://aws.random.cat/meow').send(); - - console.log(r.json()); -}); -``` -##### Result -```sh -$ node test.js -{ file: 'https://purr.objects-us-east-1.dream.io/i/100_-_rURSo7L.gif' } -``` - -### Sending data in a JSON body to a server - -#### Getting a response from a REST API -**Code**: -```js -const w = require('wumpfetch'); - -// Using an URL and custom options -;(async() => { - let req = await w('https://aws.random.cat/meow', { - chaining: false, - headers: { - 'User-Agent': 'Project/0.0.1' - } - }); - // Only URL - req = await w('https://aws.random.cat/meow', { chaining: false }); - // Only options - req = await w({ - url: 'https://aws.random.cat/meow', - chaining: false, - headers: { - 'User-Agent': 'Project/0.0.1' - } - }); - - console.log(req.json()); -})(); -``` - -**Result**: -```sh -$ node test.js -{ file: 'https://purr.objects-us-east-1.dream.io/i/100_-_rURSo7L.gif' } -``` - -#### Chaining methods -You can also chain methods by adding `chaining: true` to `options` -```js -const w = require('wumpfetch'); - -;(async() => { - const r = await w('https://my-site.com/postboi', { method: 'POST' }) - .timeout(1000) // Set a 1s timeout - .query('video', 'wumpboye') // Add a query - .header({ 'Authorization': 'Pablito' }) // Set a header - .body({ x: 'y', z: 1, beep: 'boop', chocolate: true }) // Send a JSON body - .send(); // Finish the chain by sending the rquest - - console.log(r.json()); // Returns the response in a JSON format -})(); -``` - -## Projects using Wumpfetch - -> If you want your own project listed, either create a pull request or an issue with the following content: -> * Project name -> * a **short** description of your package -> -> Also add the following if your project is a package/module/library: -> * NPM link (🔩) -> * Packagephobia link (⚖) -> * GitHub repository link (📂) -> * *Optional*: A website link (👾) - -| Project Name | Short description | Links -|----------|----------|:-------------: -| boats.js | The official discord.boats API wrapper for NodeJS | [🔩](https://npmjs.com/package/boats.js) [⚖](https://packagephobia.now.sh/result?p=boats.js) [📂](https://github.com/DiscordBoats/boats.js) [👾](https://boats.js.org/?referrer=wumpfetch) -| qtradio.js | API wrapper for qtradio.moe made in JavaScript | [🔩](https://npmjs.com/package/qtradio.js) [⚖](https://packagephobia.now.sh/result?p=qtradio.js) [📂](https://github.com/auguwu/qtradio.js) [👾](https://qtradio.moe/?referrer=wumpfetch) -| cafebot.js | CafeBot.xyz API Wrapper made in JS | [🔩](https://npmjs.com/package/cafebot.js) [⚖](https://packagephobia.now.sh/result?p=cafebot.js) [📂](https://github.com/DopeDealers/cafebot.js) [👾](https://cafebot.xyz/?referrer=wumpfetch) - +## Documentation +Documentation can be found at [https://github.com/PassTheWessel/wumpfetch/wiki](https://github.com/PassTheWessel/wumpfetch/wiki) ## License [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2FPassTheWessel%2Fwumpfetch.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2FPassTheWessel%2Fwumpfetch?ref=badge_large) diff --git a/docs/logo.svg b/docs/logo.svg deleted file mode 100644 index 43afa49..0000000 --- a/docs/logo.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file