README
¶
Note
The Blues toolset for manipulating notes and the the basics for creating a hub server.
See also:
- note-go for the Go API for communicating with the Notecard + other go tools
How to contribute
Contributions are welcome!
Please read the document How to contribute which will guide you through how to build the source code, run the tests, and contribute your changes to the project.
How to install
Add the package to your go.mod file:
require github.com/blues/note
Or, clone the repository:
git clone --branch master https://github.com/blues/note.git $GOPATH/src/github.com/blues/note
Directories
¶
| Path | Synopsis |
|---|---|
|
Inbound TCP support Inbound TCP support Inbound TCP support
|
Inbound TCP support Inbound TCP support Inbound TCP support |
|
Package json implements encoding and decoding of JSON as defined in RFC 7159.
|
Package json implements encoding and decoding of JSON as defined in RFC 7159. |
|
Package notelib cert.go contains certificates Package notelib config.go is where package-wide constants and vars are defined Package notelib debug.go contains things that assist in debugging Package notelib discover.go is the notehub discovery handling support Package notelib err.go contains things that assist in error handling Package notelib errors.go contains programmatically-testable error strings Package notelib file.go is a 'storage driver' for a standard hierarchical file system Package notelib fileio.go is the lowest level I/O driver underlying the file transport Package notelib hubreq.go is the service-side complement to the Notehub client-side package Package notelib notefile.go handles management and sync of collections of individual notes Package notelib notebox.go deals with the handling of the sync'ed container of a set of related notefiles Package notelib notefile.go handles management and sync of collections of individual notes Package notelib notehub-defs contains device-hub RPC protocol definitions Package notelib is a generated protocol buffer package.
|
Package notelib cert.go contains certificates Package notelib config.go is where package-wide constants and vars are defined Package notelib debug.go contains things that assist in debugging Package notelib discover.go is the notehub discovery handling support Package notelib err.go contains things that assist in error handling Package notelib errors.go contains programmatically-testable error strings Package notelib file.go is a 'storage driver' for a standard hierarchical file system Package notelib fileio.go is the lowest level I/O driver underlying the file transport Package notelib hubreq.go is the service-side complement to the Notehub client-side package Package notelib notefile.go handles management and sync of collections of individual notes Package notelib notebox.go deals with the handling of the sync'ed container of a set of related notefiles Package notelib notefile.go handles management and sync of collections of individual notes Package notelib notehub-defs contains device-hub RPC protocol definitions Package notelib is a generated protocol buffer package. |
Click to show internal directories.
Click to hide internal directories.