Skip to content

Commit

Permalink
Updating readme (#168)
Browse files Browse the repository at this point in the history
  • Loading branch information
retgits authored and mellistibco committed May 30, 2018
1 parent 995f1bf commit 71430ff
Showing 1 changed file with 53 additions and 0 deletions.
53 changes: 53 additions & 0 deletions README.md
Expand Up @@ -7,3 +7,56 @@
## License
flogo-lib is licensed under a BSD-type license. See [LICENSE](LICENSE) for license text.

<p align="center">
<img src ="https://raw.githubusercontent.com/TIBCOSoftware/flogo/master/images/projectflogo.png" />
</p>

<p align="center" >
<b>Serverless functions and edge microservices made painless</b>
</p>

<p align="center">
<img src="https://travis-ci.org/TIBCOSoftware/flogo-lib.svg?branch=master"/>
<img src="https://img.shields.io/badge/dependencies-up%20to%20date-green.svg"/>
<img src="https://img.shields.io/badge/license-BSD%20style-blue.svg"/>
<a href="https://gitter.im/project-flogo/Lobby?utm_source=share-link&utm_medium=link&utm_campaign=share-link"><img src="https://badges.gitter.im/Join%20Chat.svg"/></a>
</p>

<p align="center">
<a href="#getting-started">Getting Started</a> | <a href="#repos">Repos</a> | <a href="#contributing">Contributing</a> | <a href="#license">License</a>
</p>

<br/>
Project Flogo is an open source framework to simplify building efficient & modern serverless functions and edge microservices and _this_ repository contains the api and core libraries that are used to create and extend those **Flogo Applications**.

## Getting started
If you want to get started with [Project Flogo](flogo.io), you might want to check out the [getting started](https://tibcosoftware.github.io/flogo/getting-started/) guide in our docs or check out the [Labs](https://tibcosoftware.github.io/flogo/labs/) section in our docs for in depth tutorials.

## Repos
[Project Flogo](https://github.com/TIBCOSoftware/flogo) consists of the following sub-projects available as separate repos:
* [flogo-cli](https://github.com/TIBCOSoftware/flogo-cli): Command line tools for building Flogo apps & extensions
* [flogo-lib](https://github.com/TIBCOSoftware/flogo-lib): The core Flogo library (you're here now)
* [flogo-services](https://github.com/TIBCOSoftware/flogo-services): Backing services required by Flogo
* [flogo-contrib](https://github.com/TIBCOSoftware/flogo-contrib): Flogo contributions/extensions

## Contributing
Want to contribute to Project Flogo? We've made it easy, all you need to do is fork the repository you intend to contribute to, make your changes and create a Pull Request! Once the pull request has been created, you'll be prompted to sign the CLA (Contributor License Agreement) online.

Not sure where to start? No problem, you can browse the Project Flogo repos and look for issues tagged `kind/help-wanted` or `good first issue`. To make this even easier, we've added the links right here too!
* Project Flogo: [kind/help-wanted](https://github.com/TIBCOSoftware/flogo/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) and [good first issue](https://github.com/TIBCOSoftware/flogo/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
* flogo-cli: [kind/help-wanted](https://github.com/TIBCOSoftware/flogo-cli/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) and [good first issue](https://github.com/TIBCOSoftware/flogo-cli/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
* flogo-lib: [kind/help-wanted](https://github.com/TIBCOSoftware/flogo-lib/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) and [good first issue](https://github.com/TIBCOSoftware/flogo-lib/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
* flogo-services: [kind/help-wanted](https://github.com/TIBCOSoftware/flogo-services/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) and [good first issue](https://github.com/TIBCOSoftware/flogo-services/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
* flogo-contrib: [kind/help-wanted](https://github.com/TIBCOSoftware/flogo-contrib/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) and [good first issue](https://github.com/TIBCOSoftware/flogo-contrib/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)

Another great way to contribute to Project Flogo is to check [flogo-contrib](https://github.com/TIBCOSoftware/flogo-contrib). That repository contains all of the contributions, such as activities, triggers, etc. Perhaps there is something missing? Create a new activity or trigger or fix a bug in an existing activity or trigger.

If you have any questions, feel free to post an issue and tag it as a question, email flogo-oss@tibco.com or chat with the team and community:

* The [project-flogo/Lobby](https://gitter.im/project-flogo/Lobby?utm_source=share-link&utm_medium=link&utm_campaign=share-link) Gitter channel should be used for general discussions, start here for all things Flogo!
* The [project-flogo/developers](https://gitter.im/project-flogo/developers?utm_source=share-link&utm_medium=link&utm_campaign=share-link) Gitter channel should be used for developer/contributor focused conversations.

For additional details, refer to the [Contribution Guidelines](https://github.com/TIBCOSoftware/flogo/blob/master/CONTRIBUTING.md).

## License
Flogo source code in [this](https://github.com/TIBCOSoftware/flogo-lib) repository is under a BSD-style license, refer to [LICENSE](https://github.com/TIBCOSoftware/flogo-lib/blob/master/LICENSE)

0 comments on commit 71430ff

Please sign in to comment.