-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
102 lines (77 loc) · 5.13 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
<!DOCTYPE html>
<html lang="en-us">
<head>
<meta charset="UTF-8">
<title>Documentation by OpenKitten</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" type="text/css" href="stylesheets/normalize.css" media="screen">
<link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700' rel='stylesheet' type='text/css'>
<link rel="stylesheet" type="text/css" href="stylesheets/stylesheet.css" media="screen">
<link rel="stylesheet" type="text/css" href="stylesheets/github-light.css" media="screen">
</head>
<body>
<section class="page-header">
<h1 class="project-name">Documentation</h1>
<h2 class="project-tagline">All OpenKitten documentation</h2>
<a href="https://github.com/OpenKitten/Documentation" class="btn">View on GitHub</a>
<a href="https://github.com/OpenKitten/Documentation/zipball/master" class="btn">Download .zip</a>
<a href="https://github.com/OpenKitten/Documentation/tarball/master" class="btn">Download .tar.gz</a>
</section>
<section class="main-content">
<h1>
<a id="documentation" class="anchor" href="#documentation" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Documentation</h1>
<p>In this repository resides all information about OpenKitten.</p>
<h3>
<a id="folder-structure" class="anchor" href="#folder-structure" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Folder structure</h3>
<p>In the root folder of this project besides this README file there reside the project directories. Each documented project has it's own direcotry named after the github project.</p>
<p>Inside each project directory is a README.md file for general information and as an index.</p>
<p>Next to the project's README reside three other directories:</p>
<ul>
<li>Tutorials</li>
<li>Examples</li>
<li>Documentation</li>
</ul>
<h2>
<a id="bson" class="anchor" href="#bson" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>BSON</h2>
<p>BSON is the underlying data format for MongoDB. This library is a high performance native Swift parser/serializer that interacts with native Swift objects whilst providing a useful and recognizable high level API.</p>
<ul>
<li><a href="BSON/README.md">BSON Index</a></li>
<li><a href="BSON/Tutorials/README.md">BSON Tutorials</a></li>
<li><a href="BSON/Examples/README.md">BSON Examples</a></li>
<li><a href="BSON/Documentation/README.md">BSON Documentation</a></li>
</ul>
<h2>
<a id="mongokitten" class="anchor" href="#mongokitten" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>MongoKitten</h2>
<p>MongoKitten is a MongoDB connector/driver written in pure Swift. MongoKitten is reliant on BSON and CryptoKitten for it's data format and encryption for authentication.</p>
<p>MongoKitten aims to empower Swift developers to experience both MongoDB and Swift in the fullest of their qualities without sacrificing features.</p>
<ul>
<li><a href="MongoKitten/README.md">MongoKitten Index</a></li>
<li><a href="MongoKitten/Tutorials/README.md">MongoKitten Tutorials</a></li>
<li><a href="MongoKitten/Examples/README.md">MongoKitten Examples</a></li>
<li><a href="MongoKitten/Documentation/README.md">MongoKitten Documentation</a></li>
</ul>
<h2>
<a id="mainecoon" class="anchor" href="#mainecoon" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Mainecoon</h2>
<p>Mainecoon is a MongoKitten/MongoDB based ORM and therefore is made for both type safety as well as flexibility. Mainecoon makes use of BSON through MongoKitten.</p>
<ul>
<li><a href="Mainecoon/README.md">Mainecoon Index</a></li>
<li><a href="Mainecoon/Tutorials/README.md">Mainecoon Tutorials</a></li>
<li><a href="Mainecoon/Examples/README.md">Mainecoon Examples</a></li>
<li><a href="Mainecoon/Documentation/README.md">Mainecoon Documentation</a></li>
</ul>
<h2>
<a id="mainecoonvapor" class="anchor" href="#mainecoonvapor" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>MainecoonVapor</h2>
<p>MainecoonVapor is a helper library providing bindings from Mainecoon/MongoKitten to Vapor. MainecoonVapor works to integrate both workflows into one a workflow that combines the two seamlessly.</p>
<ul>
<li><a href="MainecoonVapor/README.md">MainecoonVapor Index</a></li>
<li><a href="MainecoonVapor/Tutorials/README.md">MainecoonVapor Tutorials</a></li>
<li><a href="MainecoonVapor/Examples/README.md">MainecoonVapor Examples</a></li>
<li><a href="MainecoonVapor/Documentation/README.md">MainecoonVapor Documentation</a></li>
</ul>
<footer class="site-footer">
<span class="site-footer-owner"><a href="https://github.com/OpenKitten/Documentation">Documentation</a> is maintained by <a href="https://github.com/OpenKitten">OpenKitten</a>.</span>
<span class="site-footer-credits">This page was generated by <a href="https://pages.github.com">GitHub Pages</a> using the <a href="https://github.com/jasonlong/cayman-theme">Cayman theme</a> by <a href="https://twitter.com/jasonlong">Jason Long</a>.</span>
</footer>
</section>
</body>
</html>