From 29c01bc58cc46849b28c8442efd310870354cfa5 Mon Sep 17 00:00:00 2001 From: rocktimsaikia Date: Sat, 12 Sep 2020 19:51:40 +0530 Subject: [PATCH] :unicorn: chore: change package name to meta-fetcher --- package.json | 2 +- readme.md | 14 +++++++------- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/package.json b/package.json index db9add9..0d97fdf 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "meta-fetch", + "name": "meta-fetcher", "version": "1.0.0", "description": "Tiny URL meta-data fetcher that scraps the meta-data of a given URL string", "keywords": [ diff --git a/readme.md b/readme.md index 6124d09..54dd5bf 100644 --- a/readme.md +++ b/readme.md @@ -1,8 +1,8 @@ -# meta-fetch :mag_right: +# meta-fetcher :mag_right: > Tiny URL meta-data fetcher that scraps the meta-data of a given `URL` string. -![Travis (.com) branch](https://img.shields.io/travis/com/rocktimsaikia/meta-fetch/master) +![Travis (.com) branch](https://img.shields.io/travis/com/rocktimsaikia/meta-fetcher/master) [![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/xojs/xo) Under the hood it uses [node-fetch](https://github.com/node-fetch/node-fetch) to fetch the metadata, parses it and returns it as json object. @@ -10,12 +10,12 @@ Under the hood it uses [node-fetch](https://github.com/node-fetch/node-fetch) to ## Install ```sh -npm install meta-fetch +npm install meta-fetcher ``` ## Basic Usage ```js -const {fetchMetaData} = require('meta-fetch'); +const {fetchMetaData} = require('meta-fetcher'); (async () => { const result = await fetchMetaData('https://hoppscotch.io/'); @@ -56,7 +56,7 @@ const {fetchMetaData} = require('meta-fetch'); You can optionally set the `userAgent` and `fromEmail` options in request `Header` while fetching the meta-data. ```js -const {fetchMetaData} = require('meta-fetch'); +const {fetchMetaData} = require('meta-fetcher'); (async () => { const result = await fetchMetaData('https://hoppscotch.io/', { @@ -70,7 +70,7 @@ const {fetchMetaData} = require('meta-fetch'); It can also fetch meta-data from `shortened-url` .For example: ```js -const {fetchMetaData} = require('meta-fetch'); +const {fetchMetaData} = require('meta-fetcher'); (async () => { const result = await fetchMetaData('https://bit.ly/2Fj9sNF'); @@ -83,7 +83,7 @@ You can set these options in Header while fetching the data if needed. | Option | Required | Default Value | | :------------- | :----------: | -----------: | -| `userAgent` | No | `meta-fetch` | +| `userAgent` | No | `meta-fetcher` | | `fromEMail` | No | `metafetch@email.com` | ## API