jake/careful-downloader
1
Fork 0
mirror of https://github.com/jakejarvis/careful-downloader.git synced 2025-06-27 17:25:42 -04:00
Code Issues Releases Activity

rename package to careful-downloader

Browse Source
This commit is contained in:
Jake Jarvis
2021-10-06 10:09:00 -04:00
parent c5c83fe38c
commit df200ecf2e
2 changed files with 10 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -1,23 +1,23 @@
# 🕵️‍♀️ careful-download
# 🕵️‍♀️ careful-downloader
[![CI](https://github.com/jakejarvis/careful-download/actions/workflows/ci.yml/badge.svg)](https://github.com/jakejarvis/careful-download/actions/workflows/ci.yml)
[![npm](https://img.shields.io/npm/v/careful-download?logo=npm)](https://www.npmjs.com/package/careful-download)
[![MIT License](https://img.shields.io/github/license/jakejarvis/careful-download?color=red)](LICENSE)
[![CI](https://github.com/jakejarvis/careful-downloader/actions/workflows/ci.yml/badge.svg)](https://github.com/jakejarvis/careful-downloader/actions/workflows/ci.yml)
[![npm](https://img.shields.io/npm/v/careful-downloader?logo=npm)](https://www.npmjs.com/package/careful-downloader)
[![MIT License](https://img.shields.io/github/license/jakejarvis/careful-downloader?color=red)](LICENSE)
Downloads a file and its checksums to a temporary directory, validates the hash, and optionally extracts it if safe. A headache-averting wrapper around [`got`](https://github.com/sindresorhus/got), [`sumchecker`](https://github.com/malept/sumchecker), and [`decompress`](https://github.com/kevva/decompress).
## Install
```sh
npm install careful-download
npm install careful-downloader
# or...
yarn add careful-download
yarn add careful-downloader
```
## Usage
```js
import downloader from "careful-download";
import downloader from "careful-downloader";
await downloader(
"https://github.com/gohugoio/hugo/releases/download/v0.88.1/hugo_extended_0.88.1_Windows-64bit.zip",

6
package.json
View File

@ -1,9 +1,9 @@
{
"name": "careful-download",
"name": "careful-downloader",
"version": "0.0.0",
"description": "🕵️‍♀️ Downloads a file and its checksums to a temporary directory, validates the hash, and optionally extracts it if safe.",
"license": "MIT",
"homepage": "https://github.com/jakejarvis/careful-download",
"homepage": "https://github.com/jakejarvis/careful-downloader",
"author": {
"name": "Jake Jarvis",
"email": "jake@jarv.is",
@ -11,7 +11,7 @@
},
"repository": {
"type": "git",
"url": "https://github.com/jakejarvis/careful-download.git"
"url": "https://github.com/jakejarvis/careful-downloader.git"
},
"type": "module",
"exports": "./index.js",