-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdocs.go
More file actions
56 lines (37 loc) · 1.58 KB
/
docs.go
File metadata and controls
56 lines (37 loc) · 1.58 KB
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
// Copyright (c) 2017 Fadhli Dzil Ikram. All rights reserved.
// This source code is brought to you under MIT license that can be found
// on the LICENSE file.
/*
Package omnibus is a collection of high-level web application API package for
Go. Whether you build REST API endpoint to full featured website or something
in between, it got you covered. Omnibus subpackages is designed with
modularity in mind so you can easily mix and match it with another package.
Quick Start Guide
To use any subpackage in Omnibus, you should install it first with go get.
go get -u github.com/mandala/omnibus
Then, just use import statement in your code to use the omnibus subpackages.
import (
"github.com/mandala/omnibus/serve"
"github.com/mandala/omnibus/browser"
"github.com/mandala/omnibus/view"
)
Documentation
Please refer to each subpackage folder for more information on its API docs
and usage examples.
Benchmarks
Well, if you care so much about performance benchmarks please help us out to
tighten up the code and create proper benchmarking codes.
Issues and Feature requests
Please let us know on https://github.com/mandala/omnibus/issues.
Contributing
Please install Editor Config and Golang support on your favorite IDE before
start tinkering the code. Then, when you're done please send a pull request
with proper documentation.
License
Copyright (c) 2017 Fadhli Dzil Ikram. All rights reserved.
This project is licensed under MIT license that can be found on the LICENSE
file.
*/
package omnibus
// This package intentionally left blank to supress the no buildable files
// warning on go-get.