Updated docs
This commit is contained in:
Mark Qvist
parent
8478782c18
commit
110e1116e4
847
README.html
847
README.html
|
|
@ -1,847 +0,0 @@
|
||||||
<!DOCTYPE html><html><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1"><style>@font-face {
|
|
||||||
font-family: octicons-anchor;
|
|
||||||
src: url(https://cdnjs.cloudflare.com/ajax/libs/octicons/4.4.0/font/octicons.woff) format('woff');
|
|
||||||
}
|
|
||||||
|
|
||||||
* {
|
|
||||||
box-sizing: border-box;
|
|
||||||
}
|
|
||||||
|
|
||||||
body {
|
|
||||||
width: 980px;
|
|
||||||
margin-right: auto;
|
|
||||||
margin-left: auto;
|
|
||||||
color:#333;
|
|
||||||
background:#fff;
|
|
||||||
}
|
|
||||||
|
|
||||||
body .markdown-body {
|
|
||||||
padding: 45px;
|
|
||||||
border: 1px solid #ddd;
|
|
||||||
border-radius: 3px;
|
|
||||||
word-wrap: break-word;
|
|
||||||
}
|
|
||||||
|
|
||||||
pre {
|
|
||||||
font: 12px Consolas, "Liberation Mono", Menlo, Courier, monospace;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body {
|
|
||||||
-webkit-text-size-adjust: 100%;
|
|
||||||
text-size-adjust: 100%;
|
|
||||||
color: #333;
|
|
||||||
font-family: "Helvetica Neue", Helvetica, "Segoe UI", Arial, freesans, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
|
|
||||||
font-size: 16px;
|
|
||||||
line-height: 1.6;
|
|
||||||
word-wrap: break-word;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body a {
|
|
||||||
background-color: transparent;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body a:active,
|
|
||||||
.markdown-body a:hover {
|
|
||||||
outline: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body strong {
|
|
||||||
font-weight: bold;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body h1 {
|
|
||||||
font-size: 2em;
|
|
||||||
margin: 0.67em 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body img {
|
|
||||||
border: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body hr {
|
|
||||||
box-sizing: content-box;
|
|
||||||
height: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body pre {
|
|
||||||
overflow: auto;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body code,
|
|
||||||
.markdown-body kbd,
|
|
||||||
.markdown-body pre {
|
|
||||||
font-family: monospace, monospace;
|
|
||||||
font-size: 1em;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body input {
|
|
||||||
color: inherit;
|
|
||||||
font: inherit;
|
|
||||||
margin: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body html input[disabled] {
|
|
||||||
cursor: default;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body input {
|
|
||||||
line-height: normal;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body input[type="checkbox"] {
|
|
||||||
box-sizing: border-box;
|
|
||||||
padding: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body table {
|
|
||||||
border-collapse: collapse;
|
|
||||||
border-spacing: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body td,
|
|
||||||
.markdown-body th {
|
|
||||||
padding: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body input {
|
|
||||||
font: 13px / 1.4 Helvetica, arial, nimbussansl, liberationsans, freesans, clean, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body a {
|
|
||||||
color: #4078c0;
|
|
||||||
text-decoration: none;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body a:hover,
|
|
||||||
.markdown-body a:active {
|
|
||||||
text-decoration: underline;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body hr {
|
|
||||||
height: 0;
|
|
||||||
margin: 15px 0;
|
|
||||||
overflow: hidden;
|
|
||||||
background: transparent;
|
|
||||||
border: 0;
|
|
||||||
border-bottom: 1px solid #ddd;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body hr:before {
|
|
||||||
display: table;
|
|
||||||
content: "";
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body hr:after {
|
|
||||||
display: table;
|
|
||||||
clear: both;
|
|
||||||
content: "";
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body h1,
|
|
||||||
.markdown-body h2,
|
|
||||||
.markdown-body h3,
|
|
||||||
.markdown-body h4,
|
|
||||||
.markdown-body h5,
|
|
||||||
.markdown-body h6 {
|
|
||||||
margin-top: 15px;
|
|
||||||
margin-bottom: 15px;
|
|
||||||
line-height: 1.1;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body h1 {
|
|
||||||
font-size: 30px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body h2 {
|
|
||||||
font-size: 21px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body h3 {
|
|
||||||
font-size: 16px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body h4 {
|
|
||||||
font-size: 14px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body h5 {
|
|
||||||
font-size: 12px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body h6 {
|
|
||||||
font-size: 11px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body blockquote {
|
|
||||||
margin: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body ul,
|
|
||||||
.markdown-body ol {
|
|
||||||
padding: 0;
|
|
||||||
margin-top: 0;
|
|
||||||
margin-bottom: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body ol ol,
|
|
||||||
.markdown-body ul ol {
|
|
||||||
list-style-type: lower-roman;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body ul ul ol,
|
|
||||||
.markdown-body ul ol ol,
|
|
||||||
.markdown-body ol ul ol,
|
|
||||||
.markdown-body ol ol ol {
|
|
||||||
list-style-type: lower-alpha;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body dd {
|
|
||||||
margin-left: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body code {
|
|
||||||
font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace;
|
|
||||||
font-size: 12px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body pre {
|
|
||||||
margin-top: 0;
|
|
||||||
margin-bottom: 0;
|
|
||||||
font: 12px Consolas, "Liberation Mono", Menlo, Courier, monospace;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body .select::-ms-expand {
|
|
||||||
opacity: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body .octicon {
|
|
||||||
font: normal normal normal 16px/1 octicons-anchor;
|
|
||||||
display: inline-block;
|
|
||||||
text-decoration: none;
|
|
||||||
text-rendering: auto;
|
|
||||||
-webkit-font-smoothing: antialiased;
|
|
||||||
-moz-osx-font-smoothing: grayscale;
|
|
||||||
-webkit-user-select: none;
|
|
||||||
-moz-user-select: none;
|
|
||||||
-ms-user-select: none;
|
|
||||||
user-select: none;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body .octicon-link:before {
|
|
||||||
content: '\f05c';
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body:before {
|
|
||||||
display: table;
|
|
||||||
content: "";
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body:after {
|
|
||||||
display: table;
|
|
||||||
clear: both;
|
|
||||||
content: "";
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body>*:first-child {
|
|
||||||
margin-top: 0 !important;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body>*:last-child {
|
|
||||||
margin-bottom: 0 !important;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body a:not([href]) {
|
|
||||||
color: inherit;
|
|
||||||
text-decoration: none;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body .anchor {
|
|
||||||
display: inline-block;
|
|
||||||
padding-right: 2px;
|
|
||||||
margin-left: -18px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body .anchor:focus {
|
|
||||||
outline: none;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body h1,
|
|
||||||
.markdown-body h2,
|
|
||||||
.markdown-body h3,
|
|
||||||
.markdown-body h4,
|
|
||||||
.markdown-body h5,
|
|
||||||
.markdown-body h6 {
|
|
||||||
margin-top: 1em;
|
|
||||||
margin-bottom: 16px;
|
|
||||||
font-weight: bold;
|
|
||||||
line-height: 1.4;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body h1 .octicon-link,
|
|
||||||
.markdown-body h2 .octicon-link,
|
|
||||||
.markdown-body h3 .octicon-link,
|
|
||||||
.markdown-body h4 .octicon-link,
|
|
||||||
.markdown-body h5 .octicon-link,
|
|
||||||
.markdown-body h6 .octicon-link {
|
|
||||||
color: #000;
|
|
||||||
vertical-align: middle;
|
|
||||||
visibility: hidden;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body h1:hover .anchor,
|
|
||||||
.markdown-body h2:hover .anchor,
|
|
||||||
.markdown-body h3:hover .anchor,
|
|
||||||
.markdown-body h4:hover .anchor,
|
|
||||||
.markdown-body h5:hover .anchor,
|
|
||||||
.markdown-body h6:hover .anchor {
|
|
||||||
text-decoration: none;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body h1:hover .anchor .octicon-link,
|
|
||||||
.markdown-body h2:hover .anchor .octicon-link,
|
|
||||||
.markdown-body h3:hover .anchor .octicon-link,
|
|
||||||
.markdown-body h4:hover .anchor .octicon-link,
|
|
||||||
.markdown-body h5:hover .anchor .octicon-link,
|
|
||||||
.markdown-body h6:hover .anchor .octicon-link {
|
|
||||||
visibility: visible;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body h1 {
|
|
||||||
padding-bottom: 0.3em;
|
|
||||||
font-size: 2.25em;
|
|
||||||
line-height: 1.2;
|
|
||||||
border-bottom: 1px solid #eee;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body h1 .anchor {
|
|
||||||
line-height: 1;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body h2 {
|
|
||||||
padding-bottom: 0.3em;
|
|
||||||
font-size: 1.75em;
|
|
||||||
line-height: 1.225;
|
|
||||||
border-bottom: 1px solid #eee;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body h2 .anchor {
|
|
||||||
line-height: 1;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body h3 {
|
|
||||||
font-size: 1.5em;
|
|
||||||
line-height: 1.43;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body h3 .anchor {
|
|
||||||
line-height: 1.2;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body h4 {
|
|
||||||
font-size: 1.25em;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body h4 .anchor {
|
|
||||||
line-height: 1.2;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body h5 {
|
|
||||||
font-size: 1em;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body h5 .anchor {
|
|
||||||
line-height: 1.1;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body h6 {
|
|
||||||
font-size: 1em;
|
|
||||||
color: #777;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body h6 .anchor {
|
|
||||||
line-height: 1.1;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body p,
|
|
||||||
.markdown-body blockquote,
|
|
||||||
.markdown-body ul,
|
|
||||||
.markdown-body ol,
|
|
||||||
.markdown-body dl,
|
|
||||||
.markdown-body table,
|
|
||||||
.markdown-body pre {
|
|
||||||
margin-top: 0;
|
|
||||||
margin-bottom: 16px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body hr {
|
|
||||||
height: 4px;
|
|
||||||
padding: 0;
|
|
||||||
margin: 16px 0;
|
|
||||||
background-color: #e7e7e7;
|
|
||||||
border: 0 none;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body ul,
|
|
||||||
.markdown-body ol {
|
|
||||||
padding-left: 2em;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body ul ul,
|
|
||||||
.markdown-body ul ol,
|
|
||||||
.markdown-body ol ol,
|
|
||||||
.markdown-body ol ul {
|
|
||||||
margin-top: 0;
|
|
||||||
margin-bottom: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body li>p {
|
|
||||||
margin-top: 16px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body dl {
|
|
||||||
padding: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body dl dt {
|
|
||||||
padding: 0;
|
|
||||||
margin-top: 16px;
|
|
||||||
font-size: 1em;
|
|
||||||
font-style: italic;
|
|
||||||
font-weight: bold;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body dl dd {
|
|
||||||
padding: 0 16px;
|
|
||||||
margin-bottom: 16px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body blockquote {
|
|
||||||
padding: 0 15px;
|
|
||||||
color: #777;
|
|
||||||
border-left: 4px solid #ddd;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body blockquote>:first-child {
|
|
||||||
margin-top: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body blockquote>:last-child {
|
|
||||||
margin-bottom: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body table {
|
|
||||||
display: block;
|
|
||||||
width: 100%;
|
|
||||||
overflow: auto;
|
|
||||||
word-break: normal;
|
|
||||||
word-break: keep-all;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body table th {
|
|
||||||
font-weight: bold;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body table th,
|
|
||||||
.markdown-body table td {
|
|
||||||
padding: 6px 13px;
|
|
||||||
border: 1px solid #ddd;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body table tr {
|
|
||||||
background-color: #fff;
|
|
||||||
border-top: 1px solid #ccc;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body table tr:nth-child(2n) {
|
|
||||||
background-color: #f8f8f8;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body img {
|
|
||||||
max-width: 100%;
|
|
||||||
box-sizing: content-box;
|
|
||||||
background-color: #fff;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body code {
|
|
||||||
padding: 0;
|
|
||||||
padding-top: 0.2em;
|
|
||||||
padding-bottom: 0.2em;
|
|
||||||
margin: 0;
|
|
||||||
font-size: 85%;
|
|
||||||
background-color: rgba(0,0,0,0.04);
|
|
||||||
border-radius: 3px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body code:before,
|
|
||||||
.markdown-body code:after {
|
|
||||||
letter-spacing: -0.2em;
|
|
||||||
content: "\00a0";
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body pre>code {
|
|
||||||
padding: 0;
|
|
||||||
margin: 0;
|
|
||||||
font-size: 100%;
|
|
||||||
word-break: normal;
|
|
||||||
white-space: pre;
|
|
||||||
background: transparent;
|
|
||||||
border: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body .highlight {
|
|
||||||
margin-bottom: 16px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body .highlight pre,
|
|
||||||
.markdown-body pre {
|
|
||||||
padding: 16px;
|
|
||||||
overflow: auto;
|
|
||||||
font-size: 85%;
|
|
||||||
line-height: 1.45;
|
|
||||||
background-color: #f7f7f7;
|
|
||||||
border-radius: 3px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body .highlight pre {
|
|
||||||
margin-bottom: 0;
|
|
||||||
word-break: normal;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body pre {
|
|
||||||
word-wrap: normal;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body pre code {
|
|
||||||
display: inline;
|
|
||||||
max-width: initial;
|
|
||||||
padding: 0;
|
|
||||||
margin: 0;
|
|
||||||
overflow: initial;
|
|
||||||
line-height: inherit;
|
|
||||||
word-wrap: normal;
|
|
||||||
background-color: transparent;
|
|
||||||
border: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body pre code:before,
|
|
||||||
.markdown-body pre code:after {
|
|
||||||
content: normal;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body kbd {
|
|
||||||
display: inline-block;
|
|
||||||
padding: 3px 5px;
|
|
||||||
font-size: 11px;
|
|
||||||
line-height: 10px;
|
|
||||||
color: #555;
|
|
||||||
vertical-align: middle;
|
|
||||||
background-color: #fcfcfc;
|
|
||||||
border: solid 1px #ccc;
|
|
||||||
border-bottom-color: #bbb;
|
|
||||||
border-radius: 3px;
|
|
||||||
box-shadow: inset 0 -1px 0 #bbb;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body .pl-c {
|
|
||||||
color: #969896;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body .pl-c1,
|
|
||||||
.markdown-body .pl-s .pl-v {
|
|
||||||
color: #0086b3;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body .pl-e,
|
|
||||||
.markdown-body .pl-en {
|
|
||||||
color: #795da3;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body .pl-s .pl-s1,
|
|
||||||
.markdown-body .pl-smi {
|
|
||||||
color: #333;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body .pl-ent {
|
|
||||||
color: #63a35c;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body .pl-k {
|
|
||||||
color: #a71d5d;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body .pl-pds,
|
|
||||||
.markdown-body .pl-s,
|
|
||||||
.markdown-body .pl-s .pl-pse .pl-s1,
|
|
||||||
.markdown-body .pl-sr,
|
|
||||||
.markdown-body .pl-sr .pl-cce,
|
|
||||||
.markdown-body .pl-sr .pl-sra,
|
|
||||||
.markdown-body .pl-sr .pl-sre {
|
|
||||||
color: #183691;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body .pl-v {
|
|
||||||
color: #ed6a43;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body .pl-id {
|
|
||||||
color: #b52a1d;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body .pl-ii {
|
|
||||||
background-color: #b52a1d;
|
|
||||||
color: #f8f8f8;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body .pl-sr .pl-cce {
|
|
||||||
color: #63a35c;
|
|
||||||
font-weight: bold;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body .pl-ml {
|
|
||||||
color: #693a17;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body .pl-mh,
|
|
||||||
.markdown-body .pl-mh .pl-en,
|
|
||||||
.markdown-body .pl-ms {
|
|
||||||
color: #1d3e81;
|
|
||||||
font-weight: bold;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body .pl-mq {
|
|
||||||
color: #008080;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body .pl-mi {
|
|
||||||
color: #333;
|
|
||||||
font-style: italic;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body .pl-mb {
|
|
||||||
color: #333;
|
|
||||||
font-weight: bold;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body .pl-md {
|
|
||||||
background-color: #ffecec;
|
|
||||||
color: #bd2c00;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body .pl-mi1 {
|
|
||||||
background-color: #eaffea;
|
|
||||||
color: #55a532;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body .pl-mdr {
|
|
||||||
color: #795da3;
|
|
||||||
font-weight: bold;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body .pl-mo {
|
|
||||||
color: #1d3e81;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body kbd {
|
|
||||||
display: inline-block;
|
|
||||||
padding: 3px 5px;
|
|
||||||
font: 11px Consolas, "Liberation Mono", Menlo, Courier, monospace;
|
|
||||||
line-height: 10px;
|
|
||||||
color: #555;
|
|
||||||
vertical-align: middle;
|
|
||||||
background-color: #fcfcfc;
|
|
||||||
border: solid 1px #ccc;
|
|
||||||
border-bottom-color: #bbb;
|
|
||||||
border-radius: 3px;
|
|
||||||
box-shadow: inset 0 -1px 0 #bbb;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body .plan-price-unit {
|
|
||||||
color: #767676;
|
|
||||||
font-weight: normal;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body .task-list-item {
|
|
||||||
list-style-type: none;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body .task-list-item+.task-list-item {
|
|
||||||
margin-top: 3px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body .task-list-item input {
|
|
||||||
margin: 0 0.35em 0.25em -1.6em;
|
|
||||||
vertical-align: middle;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body .plan-choice {
|
|
||||||
padding: 15px;
|
|
||||||
padding-left: 40px;
|
|
||||||
display: block;
|
|
||||||
border: 1px solid #e0e0e0;
|
|
||||||
position: relative;
|
|
||||||
font-weight: normal;
|
|
||||||
background-color: #fafafa;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body .plan-choice.open {
|
|
||||||
background-color: #fff;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body .plan-choice.open .plan-choice-seat-breakdown {
|
|
||||||
display: block;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body .plan-choice-free {
|
|
||||||
border-radius: 3px 3px 0 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body .plan-choice-paid {
|
|
||||||
border-radius: 0 0 3px 3px;
|
|
||||||
border-top: 0;
|
|
||||||
margin-bottom: 20px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body .plan-choice-radio {
|
|
||||||
position: absolute;
|
|
||||||
left: 15px;
|
|
||||||
top: 18px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body .plan-choice-exp {
|
|
||||||
color: #999;
|
|
||||||
font-size: 12px;
|
|
||||||
margin-top: 5px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body .plan-choice-seat-breakdown {
|
|
||||||
margin-top: 10px;
|
|
||||||
display: none;
|
|
||||||
}
|
|
||||||
|
|
||||||
.markdown-body :checked+.radio-label {
|
|
||||||
z-index: 1;
|
|
||||||
position: relative;
|
|
||||||
border-color: #4078c0;
|
|
||||||
}
|
|
||||||
|
|
||||||
@media print {
|
|
||||||
body .markdown-body {
|
|
||||||
padding: 0;
|
|
||||||
border: none;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
</style><title>README</title></head><body><article class="markdown-body"><h1>
|
|
||||||
<a id="user-content-reticulum-network-stack-α" class="anchor" href="#reticulum-network-stack-%CE%B1" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Reticulum Network Stack α</h1>
|
|
||||||
<p>Reticulum is a cryptography-based networking stack for wide-area networks built on readily available hardware, and can operate even with very high latency and extremely low bandwidth. Reticulum allows you to build very wide-area networks with off-the-shelf tools, and offers end-to-end encryption, autoconfiguring cryptographically backed multi-hop transport, efficient addressing, unforgeable packet acknowledgements and more.</p>
|
|
||||||
<p>Reticulum is a complete networking stack, and does not use IP or higher layers, although it is easy to utilise IP (with TCP or UDP) as the underlying carrier for Reticulum. It is therefore trivial to tunnel Reticulum over the Internet or private IP networks.</p>
|
|
||||||
<p>Having no dependencies on traditional networking stacks free up overhead that has been utilised to implement a networking stack built directly on cryptographic principles, allowing resilience and stable functionality in open and trustless networks.</p>
|
|
||||||
<p>No kernel modules or drivers are required. Reticulum runs completely in userland, and can run on practically any system that runs Python 3.</p>
|
|
||||||
<p>For more info, see <a href="https://unsigned.io/projects/reticulum/" rel="nofollow">unsigned.io/projects/reticulum</a></p>
|
|
||||||
<h2>
|
|
||||||
<a id="user-content-notable-features" class="anchor" href="#notable-features" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Notable Features</h2>
|
|
||||||
<ul>
|
|
||||||
<li>Coordination-less globally unique adressing and identification</li>
|
|
||||||
<li>Fully self-configuring multi-hop routing</li>
|
|
||||||
<li>Asymmetric RSA encryption and signatures as basis for all communication</li>
|
|
||||||
<li>Perfect Forward Secrecy on links with ephemereal Elliptic Curve Diffie-Hellman keys (on the SECP256R1 curve)</li>
|
|
||||||
<li>Reticulum uses the <a href="https://github.com/fernet/spec/blob/master/Spec.md">Fernet</a> specification for encryption on links and to group destinations
|
|
||||||
<ul>
|
|
||||||
<li>AES-128 in CBC mode with PKCS7 padding</li>
|
|
||||||
<li>HMAC using SHA256 for authentication</li>
|
|
||||||
<li>IVs are generated through os.urandom()</li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
<li>Unforgeable packet delivery confirmations</li>
|
|
||||||
<li>A variety of supported interface types</li>
|
|
||||||
<li>An intuitive and easy-to-use API</li>
|
|
||||||
<li>Reliable and efficient transfer of arbritrary amounts of data
|
|
||||||
<ul>
|
|
||||||
<li>Reticulum can handle a few bytes of data or files of many gigabytes</li>
|
|
||||||
<li>Sequencing, transfer coordination and checksumming is automatic</li>
|
|
||||||
<li>The API is very easy to use, and provides transfer progress</li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
<h2>
|
|
||||||
<a id="user-content-where-can-reticulum-be-used" class="anchor" href="#where-can-reticulum-be-used" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Where can Reticulum be used?</h2>
|
|
||||||
<p>On practically any hardware that can support at least a half-duplex channel with 1.000 bits per second throughput, and an MTU of 500 bytes. Data radios, modems, LoRa radios, serial lines, AX.25 TNCs, amateur radio digital modes, ad-hoc WiFi, free-space optical links and similar systems are all examples of the types of interfaces Reticulum was designed for.</p>
|
|
||||||
<p>An open-source LoRa-based interface called <a href="https://unsigned.io/projects/rnode/" rel="nofollow">RNode</a> has been designed specifically for use with Reticulum. It is possible to build yourself, or it can be purchased as a complete transceiver that just needs a USB connection to the host.</p>
|
|
||||||
<p>Reticulum can also be encapsulated over existing IP networks, so there's nothing stopping you from using it over wired ethernet or your local WiFi network, where it'll work just as well. In fact, one of the strengths of Reticulum is how easily it allows you to connect different mediums into a self-configuring, resilient and encrypted mesh.</p>
|
|
||||||
<p>As an example, it's possible to set up a Raspberry Pi connected to both a LoRa radio, a packet radio TNC and a WiFi network. Once the interfaces are configured, Reticulum will take care of the rest, and any device on the WiFi network can communicate with nodes on the LoRa and packet radio sides of the network, and vice versa.</p>
|
|
||||||
<h2>
|
|
||||||
<a id="user-content-current-status" class="anchor" href="#current-status" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Current Status</h2>
|
|
||||||
<p>Consider Reticulum in extended testing at this stage. All core protocol features are implemented and functioning, but additions and changes can still occur if it is warranted.</p>
|
|
||||||
<p>An API- and wireformat-stable beta is near at hand.</p>
|
|
||||||
<h2>
|
|
||||||
<a id="user-content-supported-interface-types-and-devices" class="anchor" href="#supported-interface-types-and-devices" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Supported interface types and devices</h2>
|
|
||||||
<p>Reticulum implements a range of generalised interface types that covers most of the communications hardware that Reticulum can run over. If your hardware is not supported, it's relatively simple to implement an interface class. Currently, the following interfaces are supported:</p>
|
|
||||||
<ul>
|
|
||||||
<li>Any ethernet device</li>
|
|
||||||
<li>LoRa using <a href="https://unsigned.io/projects/rnode/" rel="nofollow">RNode</a>
|
|
||||||
</li>
|
|
||||||
<li>Packet Radio TNCs (with or without AX.25)</li>
|
|
||||||
<li>Any device with a serial port</li>
|
|
||||||
<li>TCP over IP networks</li>
|
|
||||||
<li>UDP over IP networks</li>
|
|
||||||
</ul>
|
|
||||||
<h2>
|
|
||||||
<a id="user-content-what-is-currently-being-worked-on" class="anchor" href="#what-is-currently-being-worked-on" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>What is currently being worked on?</h2>
|
|
||||||
<ul>
|
|
||||||
<li>API documentation</li>
|
|
||||||
<li>Useful example programs and utilities</li>
|
|
||||||
<li>A delay and disruption tolerant message transfer protocol built on Reticulum, see <a href="https://github.com/markqvist/lxmf">LXMF</a>
|
|
||||||
</li>
|
|
||||||
<li>A few useful-in-the-real-world apps built with Reticulum</li>
|
|
||||||
</ul>
|
|
||||||
<h2>
|
|
||||||
<a id="user-content-can-i-use-reticulum-on-amateur-radio-spectrum" class="anchor" href="#can-i-use-reticulum-on-amateur-radio-spectrum" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Can I use Reticulum on amateur radio spectrum?</h2>
|
|
||||||
<p>Some countries still ban the use of encryption when operating under an amateur radio license. Reticulum offers several encryptionless modes, while still using cryptographic principles for station verification, link establishment, data integrity verification, acknowledgements and routing. It is therefore perfectly possible to include Reticulum in amateur radio use, even if your country bans encryption.</p>
|
|
||||||
<h2>
|
|
||||||
<a id="user-content-dependencies" class="anchor" href="#dependencies" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Dependencies:</h2>
|
|
||||||
<ul>
|
|
||||||
<li>Python 3</li>
|
|
||||||
<li>cryptography.io</li>
|
|
||||||
<li>pyserial</li>
|
|
||||||
</ul>
|
|
||||||
<h2>
|
|
||||||
<a id="user-content-how-do-i-get-started" class="anchor" href="#how-do-i-get-started" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>How do I get started?</h2>
|
|
||||||
<p>Full documentation and tutorials are coming with the stable alpha release. Until then, you are mostly on your own. If you want to experiment already, you could take a look in the "Examples" folder, for some well-documented example programs. The default configuration file created by Reticulum on the first run is also worth reading. Be sure to also read the <a href="http://unsigned.io/wp-content/uploads/2018/04/Reticulum_Overview_v0.4.pdf" rel="nofollow">Reticulum Overview Document</a>.</p>
|
|
||||||
<p>If you just need Reticulum as a dependency for another application, the easiest way is probably via pip:</p>
|
|
||||||
<div class="highlight highlight-source-shell"><pre>pip3 install rns</pre></div>
|
|
||||||
<p>For Reticulum development, you might want to get the latest source from GitHub. In that case, don't use pip, but try this recipe:</p>
|
|
||||||
<div class="highlight highlight-source-shell"><pre><span class="pl-c"><span class="pl-c">#</span> Install dependencies</span>
|
|
||||||
pip3 install cryptography pyserial
|
|
||||||
|
|
||||||
<span class="pl-c"><span class="pl-c">#</span> Clone repository</span>
|
|
||||||
git clone https://github.com/markqvist/Reticulum.git
|
|
||||||
|
|
||||||
<span class="pl-c"><span class="pl-c">#</span> Move into Reticulum folder and symlink library to examples folder</span>
|
|
||||||
<span class="pl-c1">cd</span> Reticulum
|
|
||||||
ln -s ../RNS ./Examples/
|
|
||||||
|
|
||||||
<span class="pl-c"><span class="pl-c">#</span> Run an example</span>
|
|
||||||
python3 Examples/Echo.py -s
|
|
||||||
|
|
||||||
<span class="pl-c"><span class="pl-c">#</span> Unless you've manually created a config file, Reticulum will do so now,</span>
|
|
||||||
<span class="pl-c"><span class="pl-c">#</span> and immediately exit. Make any necessary changes to the file:</span>
|
|
||||||
nano <span class="pl-k">~</span>/.reticulum/config
|
|
||||||
|
|
||||||
<span class="pl-c"><span class="pl-c">#</span> ... and launch the example again.</span>
|
|
||||||
python3 Examples/Echo.py -s
|
|
||||||
|
|
||||||
<span class="pl-c"><span class="pl-c">#</span> You can now repeat the process on another computer,</span>
|
|
||||||
<span class="pl-c"><span class="pl-c">#</span> and run the same example with -h to get command line options.</span>
|
|
||||||
python3 Examples/Echo.py -h
|
|
||||||
|
|
||||||
<span class="pl-c"><span class="pl-c">#</span> Run the example in client mode to "ping" the server.</span>
|
|
||||||
<span class="pl-c"><span class="pl-c">#</span> Replace the hash below with the actual destination hash of your server.</span>
|
|
||||||
python3 Examples/Echo.py 3e12fc71692f8ec47bc5
|
|
||||||
|
|
||||||
<span class="pl-c"><span class="pl-c">#</span> Have a look at another example</span>
|
|
||||||
python3 Examples/Filetransfer.py -h</pre></div>
|
|
||||||
<p>The default config file contains examples for using Reticulum with LoRa transceivers (specifically <a href="https://unsigned.io/projects/rnode/" rel="nofollow">RNode</a>), packet radio TNCs/modems and UDP. By default a UDP interface is already enabled in the default config, which will enable Reticulum communication in your local ethernet broadcast domain.</p>
|
|
||||||
<p>You can use the examples in the config file to expand communication over other mediums such as packet radio or LoRa, or over fast IP links using the UDP interface. I'll add in-depth tutorials and explanations on these topics later. For now, the included examples will hopefully be enough to get started.</p>
|
|
||||||
<h2>
|
|
||||||
<a id="user-content-caveat-emptor" class="anchor" href="#caveat-emptor" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Caveat Emptor</h2>
|
|
||||||
<p>Reticulum is experimental software, and should be considered as such. While it has been built with cryptography best-practices very foremost in mind, it <em>has not</em> been externally security audited, and there could very well be privacy-breaking bugs. If you want to help out, or help sponsor an audit, please do get in touch.</p>
|
|
||||||
</article></body></html>
|
|
||||||
|
|
@ -17,7 +17,7 @@ The documentation for Reticulum is available at [unsigned.io/docs/rns/](https://
|
||||||
- Coordination-less globally unique adressing and identification
|
- Coordination-less globally unique adressing and identification
|
||||||
- Fully self-configuring multi-hop routing
|
- Fully self-configuring multi-hop routing
|
||||||
- Asymmetric RSA encryption and signatures as basis for all communication
|
- Asymmetric RSA encryption and signatures as basis for all communication
|
||||||
- Perfect Forward Secrecy on links with ephemereal Elliptic Curve Diffie-Hellman keys (on the SECP256R1 curve)
|
- Perfect Forward Secrecy on links with ephemereal Elliptic Curve Diffie-Hellman keys (on Curve25519)
|
||||||
- Reticulum uses the [Fernet](https://github.com/fernet/spec/blob/master/Spec.md) specification for encryption on links and to group destinations
|
- Reticulum uses the [Fernet](https://github.com/fernet/spec/blob/master/Spec.md) specification for encryption on links and to group destinations
|
||||||
- AES-128 in CBC mode with PKCS7 padding
|
- AES-128 in CBC mode with PKCS7 padding
|
||||||
- HMAC using SHA256 for authentication
|
- HMAC using SHA256 for authentication
|
||||||
|
|
|
||||||
|
|
@ -113,8 +113,8 @@ will be displayed as 10 bytes in hexadecimal representation, as in the following
|
||||||
By default Reticulum encrypts all data using public-key cryptography. Any message sent to a
|
By default Reticulum encrypts all data using public-key cryptography. Any message sent to a
|
||||||
destination is encrypted with that destinations public key. Reticulum can also set up an encrypted
|
destination is encrypted with that destinations public key. Reticulum can also set up an encrypted
|
||||||
channel to a destination with *Perfect Forward Secrecy* and *Initiator Anonymity* using a elliptic
|
channel to a destination with *Perfect Forward Secrecy* and *Initiator Anonymity* using a elliptic
|
||||||
curve cryptography and ephemeral keys derived from a Diffie Hellman exchange on the SECP256R1 curve.
|
curve cryptography and ephemeral keys derived from a Diffie Hellman exchange on Curve25519. In
|
||||||
In Reticulum terminology, this is called a *Link*.
|
Reticulum terminology, this is called a *Link*.
|
||||||
|
|
||||||
Reticulum also offers symmetric key encryption for group-oriented communications, as well as
|
Reticulum also offers symmetric key encryption for group-oriented communications, as well as
|
||||||
unencrypted packets for broadcast purposes, or situations where you need the communication to be in
|
unencrypted packets for broadcast purposes, or situations where you need the communication to be in
|
||||||
|
|
|
||||||
|
|
@ -17,7 +17,7 @@ What does Reticulum Offer?
|
||||||
|
|
||||||
* Asymmetric RSA encryption and signatures as basis for all communication
|
* Asymmetric RSA encryption and signatures as basis for all communication
|
||||||
|
|
||||||
* Perfect Forward Secrecy on links with ephemereal Elliptic Curve Diffie-Hellman keys (on the SECP256R1 curve)
|
* Perfect Forward Secrecy on links with ephemereal Elliptic Curve Diffie-Hellman keys (on Curve25519)
|
||||||
|
|
||||||
* Reticulum uses the Fernet specification for encryption on links and to group destinations
|
* Reticulum uses the Fernet specification for encryption on links and to group destinations
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue