Skip to content

Commit 955ebc3

Browse files
committed
docs(nano): update README
1 parent 1a92d93 commit 955ebc3

File tree

2 files changed

+12
-16
lines changed

2 files changed

+12
-16
lines changed

images/nano/Makefile

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,24 +3,24 @@ clean:
33

44
compile-linux:
55
@deno compile --target=x86_64-unknown-linux-gnu \
6-
--allow-sys --allow-env --allow-read --allow-write=__hyper__,/tmp/hyper --allow-net \
6+
--allow-run --allow-sys --allow-env --allow-read --allow-write=__hyper__,/tmp/hyper --allow-net \
77
--unstable --no-check=remote \
88
--output ./build/hyper-x86_64-unknown-linux-gnu-$(VER) mod.js
99

1010
compile-apple:
1111
@deno compile --target=x86_64-apple-darwin \
12-
--allow-sys --allow-env --allow-read --allow-write=__hyper__,/tmp/hyper --allow-net \
12+
--allow-run --allow-sys --allow-env --allow-read --allow-write=__hyper__,/tmp/hyper --allow-net \
1313
--unstable --no-check=remote \
1414
--output ./build/hyper-x86_64-apple-darwin-$(VER) mod.js
1515

1616
compile-arch-apple:
1717
@deno compile --target=aarch64-apple-darwin \
18-
--allow-sys --allow-env --allow-read --allow-write=__hyper__,/tmp/hyper --allow-net \
18+
--allow-run --allow-sys --allow-env --allow-read --allow-write=__hyper__,/tmp/hyper --allow-net \
1919
--unstable --no-check=remote \
2020
--output ./build/hyper-aarch64-apple-darwin-$(VER) mod.js
2121

2222
compile-windows:
2323
@deno compile --target=x86_64-pc-windows-msvc \
24-
--allow-sys --allow-env --allow-read --allow-write=__hyper__,/tmp/hyper --allow-net \
24+
--allow-run --allow-sys --allow-env --allow-read --allow-write=__hyper__,/tmp/hyper --allow-net \
2525
--unstable --no-check=remote \
2626
--output ./build/hyper-x86_64-pc-windows-msvc-$(VER) mod.js

images/nano/README.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ logic. `hyper-nano` is an embodiment of this approach.
3030
[`adapters`](https://docs.hyper.io/oss/building-your-own-adapter) for all of the hyper service
3131
offerings:
3232

33-
- data (powered by [PouchDB](https://github.com/hyper63/hyper-adapter-pouchdb))
33+
- data (powered by [In-Memory MongoDB](https://github.com/hyper63/hyper-adapter-mongodb))
3434
- cache (powered by [Sqlite](https://github.com/hyper63/hyper-adapter-sqlite))
3535
- storage (powered by your local [file system](https://github.com/hyper63/hyper-adapter-fs))
3636
- search (powered by [Sqlite and Minisearch](https://github.com/hyper63/hyper-adapter-minisearch))
@@ -78,7 +78,7 @@ npx hyper-nano --domain=foobar --experimental --data --cache ...
7878
Alternatively, if you use `Deno` you may run `hyper nano` directly from the source:
7979

8080
```sh
81-
deno run --allow-env --allow-read --allow-write=__hyper__ --allow-net --unstable --no-check=remote https://raw.githubusercontent.com/hyper63/hyper/main/images/nano/mod.js
81+
deno run --allow-run --allow-env --allow-read --allow-write=__hyper__ --allow-net --unstable --no-check=remote https://raw.githubusercontent.com/hyper63/hyper/main/images/nano/mod.js
8282
```
8383

8484
If you'd like to programmatically start `hyper nano`, you can import `main.js` and run `main`:
@@ -101,23 +101,23 @@ then consume your hyper instance
101101
using `HTTP`.
102102

103103
To consume using [`hyper-connect`](https://github.com/hyper63/hyper/tree/main/packages/connect) pass
104-
`http://localhost:[port]/[domain]` to `hyper-connect` as your
104+
`http://127.0.0.1:[port]/[domain]` to `hyper-connect` as your
105105
[`connection string`](https://docs.hyper.io/app-keys#nq-connection-string)
106106

107107
Consume with [`hyper-connect`](https://github.com/hyper63/hyper/tree/main/packages/connect):
108108

109109
```js
110110
import { connect } from 'hyper-connect'
111111

112-
const hyper = connect('http://localhost:6363/test')
112+
const hyper = connect('http://127.0.0.1:6363/test')
113113

114114
await hyper.data.list()
115115
```
116116

117117
Or consume via HTTP
118118

119119
```sh
120-
curl http://localhost:6363/data/test
120+
curl http://127.0.0.1:6363/data/test
121121
```
122122

123123
> Starting with Node 17, Node has changed how it resolves `localhost`, when using global `fetch` and
@@ -205,25 +205,21 @@ await main({
205205
### cache
206206

207207
```
208-
./scripts/cache.sh
208+
deno task cache
209209
```
210210

211211
### test
212212

213213
```
214-
./scripts/test.sh
214+
deno task test
215215
```
216216

217217
### compile
218218

219219
```
220-
./scripts/compile.sh
220+
make clean compile-{target}
221221
```
222222

223-
### actions
224-
225-
Github actions deploy hyper to https://hyperland.s3.amazonaws.com/hyper
226-
227223
## LICENSE
228224

229225
Apache 2.0

0 commit comments

Comments
 (0)