From 09639a923827cf0d07af6a6f4e5f4ca93d05eda3 Mon Sep 17 00:00:00 2001 From: Dmitri Zagidulin Date: Tue, 31 Aug 2021 18:05:17 -0400 Subject: [PATCH] Add README, update core deps. --- README.md | 69 ++++++++++++++++++++++++++++++++++++++++++++++- package.json | 8 +++--- test/package.json | 12 ++++----- 3 files changed, 78 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 06e90df..c6b1fa1 100644 --- a/README.md +++ b/README.md @@ -1 +1,68 @@ -# bedrock-module-template-http \ No newline at end of file +# Bedrock HTTP API Module Template _(bedrock-module-template-http)_ + +[![Build Status](https://img.shields.io/github/workflow/status/digitalbazaar/bedrock-module-template-http/Bedrock%20Node.js%20CI)](https://github.com/digitalbazaar/bedrock-module-template-http/actions?query=workflow%3A%22Bedrock+Node.js+CI%22) +[![NPM Version](https://img.shields.io/npm/v/bedrock-module-template-http.svg)](https://npm.im/bedrock-module-template-http) + +> A template for HTTP API modules for Bedrock applications. + +## Table of Contents + +- [Background](#background) +- [Security](#security) +- [Install](#install) +- [Usage](#usage) +- [Contribute](#contribute) +- [Commercial Support](#commercial-support) +- [License](#license) + +## Background + +TBD + +## Security + +TBD + +## Install + +- Node.js 12+ is required. + +### NPM + +To install via NPM: + +``` +npm install --save bedrock-module-template-http +``` + +### Development + +To install locally (for development): + +``` +git clone https://github.com/digitalbazaar/bedrock-module-template-http.git +cd bedrock-module-template-http +npm install +``` + +## Usage + +Describe configuration, usage. + +## Contribute + +See [the contribute file](https://github.com/digitalbazaar/bedrock/blob/master/CONTRIBUTING.md)! + +PRs accepted. + +If editing the Readme, please conform to the +[standard-readme](https://github.com/RichardLitt/standard-readme) specification. + +## Commercial Support + +Commercial support for this library is available upon request from +Digital Bazaar: support@digitalbazaar.com + +## License + +[Bedrock Non-Commercial License v1.0](LICENSE.md) © Digital Bazaar diff --git a/package.json b/package.json index fb148e6..8265c7b 100644 --- a/package.json +++ b/package.json @@ -26,15 +26,15 @@ "esm": "^3.2.25" }, "peerDependencies": { - "bedrock": "^4.1.1", - "bedrock-express": "^3.2.0" + "bedrock": "^4.4.0", + "bedrock-express": "^5.0.1" }, "directories": { "lib": "./lib" }, "devDependencies": { - "eslint": "^7.14.0", - "eslint-config-digitalbazaar": "^2.6.1" + "eslint": "^7.32.0", + "eslint-config-digitalbazaar": "^2.8.0" }, "engines": { "node": ">=12" diff --git a/test/package.json b/test/package.json index 752b392..0105fc8 100644 --- a/test/package.json +++ b/test/package.json @@ -9,13 +9,13 @@ "coverage-report": "nyc report" }, "dependencies": { - "bedrock": "^4.1.1", - "bedrock-express": "^3.2.0", - "bedrock-https-agent": "^2.0.0", + "bedrock": "^4.4.0", + "bedrock-express": "^5.0.1", + "bedrock-https-agent": "^2.1.0", "bedrock-module-template-http": "file:..", - "bedrock-mongodb": "^8.2.0", - "bedrock-server": "^2.7.0", - "bedrock-test": "^5.3.2", + "bedrock-mongodb": "^8.4.0", + "bedrock-server": "^3.0.0", + "bedrock-test": "^5.4.0", "cross-env": "^7.0.3", "nyc": "^15.1.0" },