Skip to content
Permalink
Browse files

fixed: update readme

  • Loading branch information...
primalmotion committed May 1, 2019
1 parent 284ffe3 commit f5cbbe3cac878d0885ae3d019339aaae098e610b
Showing with 2 additions and 4 deletions.
  1. +2 −4 README.md
@@ -2,12 +2,10 @@

[![codecov](https://codecov.io/gh/aporeto-inc/bahamut/branch/master/graph/badge.svg?token=gMtfEkiWUa)](https://codecov.io/gh/aporeto-inc/bahamut)

> README IS A WORK IN PROGRESS AS WE ARE WRITTING MORE DOCUMENTATION ABOUT THIS PACKAGE.
Bahamut is a Go library that provides everything you need to set up a full blown API server based on an [Elemental](https://go.aporeto.io/elemental) model generated from a [Regolithe Specification](https://go.aporeto.io/regolithe).

The main concept of Bahamut is to only write core business logic, and letting it handle all the boring bookkeeping. You can implement various Processors interfaces, and register them when you start a Bahamut Server.

The included Monolithe plugin generates all the needed routes and handlers to reroute the client requests to the correct method of the correct processor. Those handlers will perform basic operations, like validating the request's data are valid and conform to the specifications. When your processor is finally called, you can be sure that all basic possible errors have been checked and that you can safely assume everything is ready to be stored, retrieved, or computed.

A Bahamut Server is not directly responsible for storing an retrieving data from a database. To do so, you can use any backend library you like in your processors, but we recommend using [Manipulate](https://go.aporeto.io/manipulate), which provides a common interface for manipulating an Elemental model and multiple implementations for MongoDB, Cassandra or MemDB (with more to come). Later on, switching from Cassandra to MongoDB will be a no brainer.

> ALL THE REST MUST BE REWRITTEN

0 comments on commit f5cbbe3

Please sign in to comment.
You can’t perform that action at this time.