git ssb - added readme · Dominic/ssb-keys@dfa34342

Paul Frazee committed on 10/29/2014, 12:25:52 AM
Parent: 0ebb74e3c98f4c1f67a18eb369cbd4f2649fd6a6

added

README.mdView
		@@ -1,0 +1,30 @@
	1	+# SSB-Keys
	2	+
	3	+A common module for secure-scuttlebutt projects, provides an API to create or load elliptic-curve keypairs.
	4	+
	5	+```js
	6	+var ssbkeys = require('ssb-keys')
	7	+
	8	+ssbkeys.create(path, function(err, k) {
	9	+ console.log(k) /* => {
	10	+ id: Buffer(...),
	11	+ public: Buffer(...),
	12	+ private: Buffer(...)
	13	+ }*/
	14	+})
	15	+
	16	+ssbkeys.load(path, function(err, k) {
	17	+ console.log(k) /* => {
	18	+ id: Buffer(...),
	19	+ public: Buffer(...),
	20	+ private: Buffer(...)
	21	+ }*/
	22	+})
	23	+
	24	+var k = ssbkeys.createSync(path)
	25	+console.log(k) /* => {
	26	+ id: Buffer(...),
	27	+ public: Buffer(...),
	28	+ private: Buffer(...)
	29	+}*/
	30	+```

Dominic / ssb-keys