From 8a2734d12242383c2944727cb67b393ae546946f Mon Sep 17 00:00:00 2001 From: Drasko DRASKOVIC Date: Sun, 9 Dec 2018 20:06:20 +0100 Subject: [PATCH] NOISSUE - Housekeeping. Update README. (#497) Signed-off-by: drasko --- .github/CONTRIBUTING.md => CONTRIBUTING.md | 0 README.md | 87 ++++++++++++++++++++-- 2 files changed, 79 insertions(+), 8 deletions(-) rename .github/CONTRIBUTING.md => CONTRIBUTING.md (100%) diff --git a/.github/CONTRIBUTING.md b/CONTRIBUTING.md similarity index 100% rename from .github/CONTRIBUTING.md rename to CONTRIBUTING.md diff --git a/README.md b/README.md index 06aa8f89..8cf7bb47 100644 --- a/README.md +++ b/README.md @@ -16,16 +16,25 @@ for building complex IoT solutions. For more details, check out the [official documentation][docs]. -## Features +Mainflux is member of the [Linux Foundation][lf] and an active contributor +to the [EdgeX Foundry][edgex] project. It has been made with :heart: by [Mainflux company][company], +which maintains the project and offers professional services around it. -- Protocol bridging (i.e. HTTP, MQTT, WebSocket, CoAP) +## Features +- Multi-protocol connectivity and protocol bridging (HTTP, MQTT, WebSocket and CoAP) - Device management and provisioning - Fine-grained access control +- Storage support (Cassandra, InfluxDB and MongoDB) - Platform logging and instrumentation support -- Container-based deployment using [Docker][docker] - -## Quickstart +- Event sourcing +- Container-based deployment using [Docker][docker] and [Kubernetes][kubernetes] +- [LoRaWAN][lora] network integration +- SDK +- CLI +- Small memory footprint and fast execution +- Domain-driven design architecture, high-quality code and test coverage +## Install Before proceeding, install the following prerequisites: - [Docker](https://docs.docker.com/install/) @@ -37,20 +46,62 @@ Once everything is installed, execute the following commands from project root: docker-compose -f docker/docker-compose.yml up -d ``` -## Contributing +This will bring up all Mainflux dockers and inter-connect them in the composition. +## Usage +Best way to quickstart using Mainflux is via CLI: +``` +make cli +./build/mainflux-cli version +``` + +> Mainflux CLI can also be downloaded as a tarball from [offical release page][rel] + +If this works, head to [official documentation][docs] to understand Mainflux provisioning and messaging. + +## Documentation +Official documentation is hosted at [Mainflux Read The Docs page][docs]. + +Documentation is auto-generated from Markdown files in `./docs` directory. +If you spot an error or need for corrections, please let us know - or even better: send us a PR. + +Additional practical information, news and tutorials can be found on the [Mainflux blog][blog]. + +## Authors +Main architect and BDFL of Mainflux project is [@drasko][drasko]. + + +Additionally, [@nmarcetic][nikola] and [@janko-isidorovic][janko] assured +overall architecture and design, while [@manuIO][manu] and [@darkodraskovic][darko] +helped with crafting initial implementation and continiusly work on the project evolutions. + +Besides them, Mainflux is constantly improved and actively +developed by [@anovakovic01][alex], [@dusanb94][dusan], [@srados][sava], +[@gsaleh][george], [@blokovi][iva], [@chombium][kole] and a large set of contributors. + +Maintainers are listed in [MAINTAINERS](MAINTAINERS) file. + +## Contributing Thank you for your interest in Mainflux and wish to contribute! 1. Take a look at our [open issues](https://github.com/mainflux/mainflux/issues). -2. Checkout the [contribution guide](.github/CONTRIBUTING.md) to learn more about our style and conventions. +2. Checkout the [contribution guide](CONTRIBUTING.md) to learn more about our style and conventions. 3. Make your changes compatible to our workflow. -## Community +### We're Hiring +If you are interested in working professionally on Mainflux, +please head to company's [careers page][careers] or shoot us an e-mail at . +Note that the best way to grab our attention is by sending PRs :sunglasses:. + +## Community - [Google group][forum] - [Gitter][gitter] - [Twitter][twitter] +## License +[Apache-2.0](LICENSE) + [banner]: https://github.com/mainflux/mainflux/blob/master/docs/img/gopherBanner.jpg [ci-badge]: https://semaphoreci.com/api/v1/mainflux/mainflux/branches/master/badge.svg [ci-url]: https://semaphoreci.com/mainflux/mainflux @@ -65,3 +116,23 @@ Thank you for your interest in Mainflux and wish to contribute! [cov-url]: https://codecov.io/gh/mainflux/mainflux [license]: https://img.shields.io/badge/license-Apache%20v2.0-blue.svg [twitter]: https://twitter.com/mainflux +[lora]: https://lora-alliance.org/ +[kubernetes]: https://kubernetes.io/ +[rel]: https://github.com/mainflux/mainflux/releases +[careers]: https://www.mainflux.com/careers.html +[lf]: https://www.linuxfoundation.org/ +[edgex]: https://www.edgexfoundry.org/ +[company]: https://www.mainflux.com/ +[blog]: https://medium.com/mainflux-iot-platform +[drasko]: https://github.com/drasko +[nikola]: https://github.com/nmarcetic +[dejan]: https://github.com/mijicd +[manu]: https://github.com/manuIO +[darko]: https://github.com/darkodraskovic +[janko]: https://github.com/janko-isidorovic +[alex]: https://github.com/anovakovic01 +[dusan]: https://github.com/dusanb94 +[sava]: https://github.com/srados +[george]: https://github.com/gesaleh +[iva]: https://github.com/blokovi +[kole]: https://github.com/chombium