Mirroristas/gun
2
0
Fork 0
mirror of https://github.com/amark/gun.git synced 2025-06-12 09:06:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Begin adding browserify docs

Browse Source 
Not yet working.
This commit is contained in:
Dan Finlay 2018-11-23 16:42:00 -08:00
parent f263b4d066
commit a0f101b1e5
No known key found for this signature in database
GPG Key ID: 931102F24B36007A
1 changed files with 31 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -90,6 +90,26 @@ gun.get('list').set({type: "cucumber", goal: "scare cat"});
Want to keep building more? **Jump to [THE DOCUMENTATION](#documentation)!**
### Importing Modules with Browserify
To install with npm, first install `npm install gun -S`.
For just the networking layer, import Gun:
```javascript
var Gun = require('gun/gun');
```
If you also need to install SEA for user auth and crypto, also install some of its unincluded dependencies like this:
`npm install @trust/crypto --save`
You will need to require it too (it will be automatically added to the Gun object):
```javascript
var Gun = require('gun/gun');
var Sea = require('gun/sea');
```
# What is GUN?
First & foremost, GUN is **a community of the nicest and most helpful people** out there. So [I want to invite you](https://gitter.im/amark/gun) to come tell us about what **you** are working on & wanting to build (new or old school alike! Just be nice as well.) and ask us your questions directly. :)