Skip to content

Commit 09639a9

Browse files
Add README, update core deps.
1 parent 0061c2b commit 09639a9

File tree

3 files changed

+78
-11
lines changed

3 files changed

+78
-11
lines changed

README.md

Lines changed: 68 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,68 @@
1-
# bedrock-module-template-http
1+
# Bedrock HTTP API Module Template _(bedrock-module-template-http)_
2+
3+
[![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)
4+
[![NPM Version](https://img.shields.io/npm/v/bedrock-module-template-http.svg)](https://npm.im/bedrock-module-template-http)
5+
6+
> A template for HTTP API modules for Bedrock applications.
7+
8+
## Table of Contents
9+
10+
- [Background](#background)
11+
- [Security](#security)
12+
- [Install](#install)
13+
- [Usage](#usage)
14+
- [Contribute](#contribute)
15+
- [Commercial Support](#commercial-support)
16+
- [License](#license)
17+
18+
## Background
19+
20+
TBD
21+
22+
## Security
23+
24+
TBD
25+
26+
## Install
27+
28+
- Node.js 12+ is required.
29+
30+
### NPM
31+
32+
To install via NPM:
33+
34+
```
35+
npm install --save bedrock-module-template-http
36+
```
37+
38+
### Development
39+
40+
To install locally (for development):
41+
42+
```
43+
git clone https://github.com/digitalbazaar/bedrock-module-template-http.git
44+
cd bedrock-module-template-http
45+
npm install
46+
```
47+
48+
## Usage
49+
50+
Describe configuration, usage.
51+
52+
## Contribute
53+
54+
See [the contribute file](https://github.com/digitalbazaar/bedrock/blob/master/CONTRIBUTING.md)!
55+
56+
PRs accepted.
57+
58+
If editing the Readme, please conform to the
59+
[standard-readme](https://github.com/RichardLitt/standard-readme) specification.
60+
61+
## Commercial Support
62+
63+
Commercial support for this library is available upon request from
64+
Digital Bazaar: [email protected]
65+
66+
## License
67+
68+
[Bedrock Non-Commercial License v1.0](LICENSE.md) © Digital Bazaar

package.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,15 @@
2626
"esm": "^3.2.25"
2727
},
2828
"peerDependencies": {
29-
"bedrock": "^4.1.1",
30-
"bedrock-express": "^3.2.0"
29+
"bedrock": "^4.4.0",
30+
"bedrock-express": "^5.0.1"
3131
},
3232
"directories": {
3333
"lib": "./lib"
3434
},
3535
"devDependencies": {
36-
"eslint": "^7.14.0",
37-
"eslint-config-digitalbazaar": "^2.6.1"
36+
"eslint": "^7.32.0",
37+
"eslint-config-digitalbazaar": "^2.8.0"
3838
},
3939
"engines": {
4040
"node": ">=12"

test/package.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@
99
"coverage-report": "nyc report"
1010
},
1111
"dependencies": {
12-
"bedrock": "^4.1.1",
13-
"bedrock-express": "^3.2.0",
14-
"bedrock-https-agent": "^2.0.0",
12+
"bedrock": "^4.4.0",
13+
"bedrock-express": "^5.0.1",
14+
"bedrock-https-agent": "^2.1.0",
1515
"bedrock-module-template-http": "file:..",
16-
"bedrock-mongodb": "^8.2.0",
17-
"bedrock-server": "^2.7.0",
18-
"bedrock-test": "^5.3.2",
16+
"bedrock-mongodb": "^8.4.0",
17+
"bedrock-server": "^3.0.0",
18+
"bedrock-test": "^5.4.0",
1919
"cross-env": "^7.0.3",
2020
"nyc": "^15.1.0"
2121
},

0 commit comments

Comments
 (0)