Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
Signed-off-by: Drasko DRASKOVIC <[email protected]>
  • Loading branch information
drasko committed Sep 1, 2020
1 parent 80f9015 commit a8dbab4
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 16 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
build
18 changes: 4 additions & 14 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@

Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
https://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

Expand Down Expand Up @@ -175,24 +176,13 @@

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]
Copyright 2015-2020 Mainflux

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0
https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
Expand Down
28 changes: 26 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,26 @@
# mgate
Mainflux API Gateway
# mGate
mGate is an IoT API Gateway.

It is deployed in front of Mainflux system and can be used for authorization,
packet inspection and modification, logging and debugging and various other purposes.

## Usage
```bash
go get github.com/mainflux/mgate
cd $(GOPATH)/github.com/mainflux/mgate
make
./mgate
```

## Architecture
mProxy starts TCP, UDP and WS servers, offering connections to devices. Upon the connection, it establishes
a session with a remote MQTT and CoAP brokers.

Lorem ipsum...

## Deployment
mProxy does not do load balancing - just pure and simple proxying. This is why it should be deployed
right in front of some LB like NginX or Traefik that wil load-balance TCP and UDP packets.

## License
[Apache-2.0](LICENSE)

0 comments on commit a8dbab4

Please sign in to comment.