Skip to content

Commit 2ab7aff

Browse files
committed
added installtion instructions and todo
1 parent d43e3d0 commit 2ab7aff

File tree

2 files changed

+29
-6
lines changed

2 files changed

+29
-6
lines changed

.vscode/settings.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
2-
"editor.defaultFormatter": "esbenp.prettier-vscode",
3-
"[javascript]": {
4-
"editor.defaultFormatter": "esbenp.prettier-vscode"
5-
},
6-
"typescript.preferences.importModuleSpecifier": "relative",
7-
"editor.formatOnSave": true,
2+
"editor.defaultFormatter": "esbenp.prettier-vscode",
3+
"[javascript]": {
4+
"editor.defaultFormatter": "esbenp.prettier-vscode"
5+
},
6+
"typescript.preferences.importModuleSpecifier": "relative",
7+
"editor.formatOnSave": true
88
}

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,12 @@
33
This plugin allows generating a signed url for a file link/id. Useful when
44
using with AWS S3 sign urls for private objects.
55

6+
## Installation
7+
8+
```
9+
npm i hapi-signed-url
10+
```
11+
612
## Basic Usage
713

814
- Import the plugin
@@ -113,3 +119,20 @@ server.route({
113119

114120
- It will work with single objects and arrays. `pathToSource` is optional field,
115121
use when nested objects are to be updated.
122+
123+
- Improvements todo
124+
- Change the options structure to following, which will allow using multiple paths
125+
126+
```js
127+
const options = {
128+
sources: [
129+
{
130+
lenses: [nameLens],
131+
},
132+
{
133+
lenses: [fileLens],
134+
path: docLens,
135+
},
136+
],
137+
};
138+
```

0 commit comments

Comments
 (0)