git ssb

7+

dinoworm 🐛 / patchcore



Commit da8210bf8d2bde1d6fd3e06c8d0697ff1804afd9

add README (#2)

Mikey authored on 2/22/2017, 3:14:48 AM
GitHub committed on 2/22/2017, 3:14:48 AM
Parent: 6bb2ee8132fe243c45b55f4da55306f14d7c0f5a

Files changed

README.mdadded
README.mdView
@@ -1,0 +1,62 @@
1 +# patchcore
2 +
3 +a shared library to build [ssb](https://scuttlebot.io) apps
4 +
5 +or _the shared assumptions of all (or most) ssb related applications_
6 +
7 +## apps
8 +
9 +here's a list of apps in the wild using `patchcore`:
10 +
11 +- [`patchwork-next`](https://github.com/mmckegg/patchwork-next)
12 +- [(add yours here)](https://github.com/ssbc/patchcore/edit/master/README.md)
13 +
14 +## plugins
15 +
16 +here's a list of plugins that build on top of `patchcore`:
17 +
18 +- [(add yours here)](https://github.com/ssbc/patchcore/edit/master/README.md)
19 +
20 +## directory structure
21 +
22 +the `patchcore` files are organized in the following hierarchy:
23 +
24 +> ${topic} / ${type} / ${module}.js
25 +
26 +or when module name is different from file name:
27 +
28 +> ${topic} / ${type} / ${module} / ${file}.js
29 +
30 +### topics
31 +
32 +- lib (junk that isn't part of any topic and should really be published as a reusable module, but too lazy)
33 +- about
34 +- blob
35 +- config
36 +- contact
37 +- emoji
38 +- feed
39 +- invite
40 +- keys
41 +- message
42 +- sbot
43 +
44 +### types
45 +
46 +- sync
47 +- async
48 +- pull
49 +- obs
50 +- html
51 +
52 +## license
53 +
54 +[The MIT License (MIT)](https://mit-license.org/)
55 +
56 +Copyright © 2017 Secure Scuttlebutt Consortium
57 +
58 +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
59 +
60 +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
61 +
62 +THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Built with git-ssb-web