From 34858f5e744f19795a98cff54fdb4d84d33e8b90 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=C3=A9ctor=20Gonz=C3=A1lez?= Date: Mon, 15 Oct 2018 15:32:25 -0500 Subject: [PATCH] I've added badges describing who made the library and the language the library is made with. Also I've added a new footer and a how-to-contribute section. --- README.md | 46 +++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 45 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 624d05f..a9fe95e 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,13 @@ ![README Cover Image](readme_cover.png) +
+ # Conekta Java 2.1.5 +[![Made with Java](https://img.shields.io/badge/made%20with-java-red.svg?style=for-the-badge&colorA=ED4040&colorB=C12C2D)](http://www.java.com) [![By Conekta](https://img.shields.io/badge/by-conekta-red.svg?style=for-the-badge&colorA=ee6130&colorB=00a4ac)](https://conekta.com) +
+ + This is a java library that allows interaction with https://api.conekta.io API. ## Installation @@ -291,6 +297,44 @@ Developed in Mexico by [Conekta](https://www.conekta.com). Available with [MIT L *** +## License + +Developed in Mexico by [Conekta](https://www.conekta.com). Available with [MIT License](LICENSE). + +## How to contribute to the project + +1. Fork the repository + +2. Clone the repository +``` + git clone git@github.com:yourUserName/conekta-java.git +``` +3. Create a branch +``` + git checkout develop + git pull origin develop + # You should choose the name of your branch + git checkout -b +``` +4. Make necessary changes and commit those changes +``` + git add . + git commit -m "my changes" +``` +5. Push changes to GitHub +``` + git push origin +``` +6. Submit your changes for review, create a pull request + + To create a pull request, you need to have made your code changes on a separate branch. This branch should be named like this: **feature/my_feature** or **fix/my_fix**. + + Make sure that, if you add new features to our library, be sure that corresponding **unit tests** are added. + + If you go to your repository on GitHub, you’ll see a Compare & pull request button. Click on that button. + +*** + ## We are always hiring! -If you are a comfortable working with a range of backend languages (Java, Python, Ruby, PHP, etc) and frameworks, you have solid foundation in data structures, algorithms and software design with strong analytical and debugging skills. Send us your CV and GitHub to quieroser@conekta.com \ No newline at end of file +If you are a comfortable working with a range of backend languages (Java, Python, Ruby, PHP, etc) and frameworks, you have solid foundation in data structures, algorithms and software design with strong analytical and debugging skills, check our open positions: https://www.conekta.com/careers