mirror of
https://github.com/amark/gun.git
synced 2025-07-09 14:22:33 +00:00
use file for development, s3 for deployment.
This commit is contained in:
parent
140f2447dc
commit
4628d1c50e
17
README.md
17
README.md
@ -16,11 +16,12 @@ Now you can require it in the app you want to build.
|
|||||||
var Gun = require('gun');
|
var Gun = require('gun');
|
||||||
```
|
```
|
||||||
|
|
||||||
Once included, initialize a gun instance with your AWS S3 credentials.
|
Once included, initialize a gun instance with a file path or your AWS S3 credentials.
|
||||||
|
|
||||||
```javascript
|
```javascript
|
||||||
var gun = Gun({
|
var gun = Gun({
|
||||||
s3: {
|
file: 'data.json',
|
||||||
|
s3: { // Optional!
|
||||||
key: '', // AWS Access Key
|
key: '', // AWS Access Key
|
||||||
secret: '', // AWS Secret Token
|
secret: '', // AWS Secret Token
|
||||||
bucket: '' // The bucket you want to save into
|
bucket: '' // The bucket you want to save into
|
||||||
@ -28,7 +29,9 @@ var gun = Gun({
|
|||||||
});
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
S3 is the default persistence layer, it can be replaced with others.
|
These are the default persistence layers, they are modular and can be replaced others.
|
||||||
|
|
||||||
|
Using S3 is recommended for deployment, and using a file is recommended for local development.
|
||||||
|
|
||||||
Now you can save your first object, and create a reference to it.
|
Now you can save your first object, and create a reference to it.
|
||||||
|
|
||||||
@ -40,13 +43,7 @@ Altogether, try it with the node hello world web server which will reply with yo
|
|||||||
|
|
||||||
```javascript
|
```javascript
|
||||||
var Gun = require('gun');
|
var Gun = require('gun');
|
||||||
var gun = Gun({
|
var gun = Gun({ file: 'data.json' });
|
||||||
s3: {
|
|
||||||
key: '', // AWS Access Key
|
|
||||||
secret: '', // AWS Secret Token
|
|
||||||
bucket: '' // The bucket you want to save into
|
|
||||||
}
|
|
||||||
});
|
|
||||||
gun.set({ hello: 'world' }).key('my/first/data');
|
gun.set({ hello: 'world' }).key('my/first/data');
|
||||||
|
|
||||||
var http = require('http');
|
var http = require('http');
|
||||||
|
Loading…
x
Reference in New Issue
Block a user