Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add README, update core deps. #5

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add README, update core deps. #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 68 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,68 @@
# bedrock-module-template-http
# 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: [email protected]

## License

[Bedrock Non-Commercial License v1.0](LICENSE.md) © Digital Bazaar
8 changes: 4 additions & 4 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
12 changes: 6 additions & 6 deletions test/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
},
Expand Down