Skip to content

Commit

Permalink
fix(connect): add files to package.json update README
Browse files Browse the repository at this point in the history
  • Loading branch information
TillaTheHun0 committed Apr 12, 2022
1 parent 8850f97 commit d3243aa
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 5 deletions.
8 changes: 7 additions & 1 deletion packages/connect/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<h1 align="center">⚡️ hyper-connect ⚡️</h1>
<p align="center">
hyper-connect is a client for [hyper](https://docs.hyper.io) - the client leverages the `Request` object from the fetch specification to construct a http request to send to the hyper server. The hyper-connect library handles all of the redundant details of a fetch request, so you can just specify the unique differences of your request.
hyper-connect is a client for <a href="https://docs.hyper.io">hyper</a>
</p>
<p align="center">
<a href="https://nest.land/package/hyper-connect"><img src="https://nest.land/badge.svg" alt="Nest Badge" /></a>
Expand Down Expand Up @@ -29,6 +29,12 @@ hyper-connect is a client for [hyper](https://docs.hyper.io) - the client levera
npm install hyper-connect
```

`hyper-connect` constructs a
[Request Object](https://developer.mozilla.org/en-US/docs/Web/API/Request) and
sends it to the hyper server using `fetch`. `hyper-connect` wraps your hyper
app's REST API, generating short-lived JWTs using the provided connection
string.

## Getting Started

> New Experimental Feature: hyper Queue worker support,
Expand Down
14 changes: 10 additions & 4 deletions packages/connect/package.json
Original file line number Diff line number Diff line change
@@ -1,22 +1,28 @@
{
"name": "hyper-connect",
"version": "0.1.16",
"license": "Apache-2.0",
"type": "module",
"types": "dist/index.d.ts",
"source": "src/index.ts",
"description": "A client built on fetch to consume hyper services",
"homepage": "https://github.com/hyper63/hyper/tree/main/packages/connect",
"repository": "https://github.com/hyper63/hyper",
"exports": {
"require": "./dist/index.cjs",
"default": "./dist/index.modern.js"
},
"main": "./dist/index.cjs",
"module": "./dist/index.module.js",
"unpkg": "./dist/index.umd.js",
"module": "./dist/index.module.js",
"source": "src/index.ts",
"types": "dist/index.d.ts",
"files": [
"dist"
],
"scripts": {
"build": "microbundle",
"lint": "deno lint src && deno fmt --check src",
"test": "loadr -- uvu tests"
},
"license": "MIT",
"dependencies": {
"crocks": "^0.12.4",
"form-data": "^4.0.0",
Expand Down

0 comments on commit d3243aa

Please sign in to comment.