-
Notifications
You must be signed in to change notification settings - Fork 0
/
params.json
6 lines (6 loc) · 2.55 KB
/
params.json
1
2
3
4
5
6
{
"name": "Documentation",
"tagline": "All OpenKitten documentation",
"body": "# Documentation\r\nIn this repository resides all information about OpenKitten.\r\n\r\n### Folder structure\r\n\r\nIn 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.\r\n\r\nInside each project directory is a README.md file for general information and as an index.\r\n\r\nNext to the project's README reside three other directories:\r\n\r\n- Tutorials\r\n- Examples\r\n- Documentation\r\n\r\n## BSON\r\n\r\nBSON 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.\r\n\r\n- [BSON Index](BSON/README.md)\r\n- [BSON Tutorials](BSON/Tutorials/README.md)\r\n- [BSON Examples](BSON/Examples/README.md)\r\n- [BSON Documentation](BSON/Documentation/README.md)\r\n\r\n## MongoKitten\r\n\r\nMongoKitten 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.\r\n\r\nMongoKitten aims to empower Swift developers to experience both MongoDB and Swift in the fullest of their qualities without sacrificing features.\r\n\r\n- [MongoKitten Index](MongoKitten/README.md)\r\n- [MongoKitten Tutorials](MongoKitten/Tutorials/README.md)\r\n- [MongoKitten Examples](MongoKitten/Examples/README.md)\r\n- [MongoKitten Documentation](MongoKitten/Documentation/README.md)\r\n\r\n## Mainecoon\r\n\r\nMainecoon 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.\r\n\r\n- [Mainecoon Index](Mainecoon/README.md)\r\n- [Mainecoon Tutorials](Mainecoon/Tutorials/README.md)\r\n- [Mainecoon Examples](Mainecoon/Examples/README.md)\r\n- [Mainecoon Documentation](Mainecoon/Documentation/README.md)\r\n\r\n## MainecoonVapor\r\n\r\nMainecoonVapor 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.\r\n\r\n- [MainecoonVapor Index](MainecoonVapor/README.md)\r\n- [MainecoonVapor Tutorials](MainecoonVapor/Tutorials/README.md)\r\n- [MainecoonVapor Examples](MainecoonVapor/Examples/README.md)\r\n- [MainecoonVapor Documentation](MainecoonVapor/Documentation/README.md)",
"note": "Don't delete this file! It's used internally to help with page regeneration."
}