diff --git a/README.md b/README.md index 410510ae..e005024b 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -
+ [](https://www.npmjs.com/package/gun) [](https://travis-ci.org/amark/gun) @@ -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. :) @@ -100,16 +120,16 @@ On that note, let's get some official shout outs covered first:
Thanks to:
-Robert Heessels,
-Lorenzo Mangani,
-NLnet Foundation,
-Sam Liu,
-Daniel Dombrowsky,
-Vincent Woo,
-AJ ONeal,
+Robert Heessels,
+Lorenzo Mangani,
+NLnet Foundation,
+Sam Liu,
+Daniel Dombrowsky,
+Vincent Woo,
+AJ ONeal,
Bill Ottman,
-Mike Lange,
-Sean Matheson,
+Mike Lange,
+Sean Matheson,
Alan Mimms,
Dário Freire,
John Williamson
@@ -122,7 +142,7 @@ Thanks to:
### History
-[GUN](https://gun.eco) was created by [Mark Nadal](https://twitter.com/marknadal) in 2014 after he had spent 4 years trying to get his collaborative web app to scale up with traditional databases.
+[GUN](https://gun.eco) was created by [Mark Nadal](https://twitter.com/marknadal) in 2014 after he had spent 4 years trying to get his collaborative web app to scale up with traditional databases.
After he realized [Master-Slave database architecture causes one big bottleneck](https://gun.eco/distributed/matters.html), he (as a complete newbie outsider) naively decided **to question the status quo** and shake things up with controversial, heretical, and contrarian experiments: