Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[2.x] Readme updates #165

Merged
merged 3 commits into from
Oct 25, 2023
Merged

[2.x] Readme updates #165

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
adb9903
docs: update license and author on readme
paodb Oct 24, 2023
fce13d6
docs: update contributions section on readme
paodb Oct 24, 2023
5a89cb8
docs: add maven install section to readme
paodb Oct 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 33 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,27 @@ Try the add-on demo at http://addonsv14.flowingcode.com/twincolgrid

Official releases are available at Vaadin Directory https://vaadin.com/directory/component/twincolgrid-add-on

### Maven install

Add the following dependencies in your pom.xml file:

```xml
<dependency>
<groupId>com.flowingcode.vaadin.addons</groupId>
<artifactId>twincolgrid</artifactId>
<version>X.Y.Z</version>
</dependency>
```

```xml
<repository>
<id>vaadin-addons</id>
<url>https://maven.vaadin.com/vaadin-addons</url>
</repository>
```

For SNAPSHOT versions see [here](https://maven.flowingcode.com/snapshots/).

## Building and running demo
```
git clone https://github.com/FlowingCode/TwinColGrid
Expand All @@ -48,22 +69,21 @@ The issues for this add-on are tracked on its github.com page. All bug reports a

## Contributions

Contributions are welcome, but there are no guarantees that they are accepted as such. Process for contributing is the following:
- Fork this project
- Create an issue to this project about the contribution (bug or feature) if there is no such issue about it already. Try to keep the scope minimal.
- Develop and test the fix or functionality carefully. Only include minimum amount of code needed to fix the issue.
- Refer to the fixed issue in commit
- Send a pull request for the original project
- Comment on the original issue that you have implemented a fix for it

## License & Author
Contributions are welcome, but there are no guarantees that they are accepted as such.

Add-on is distributed under Apache License 2.0. For license terms, see LICENSE.txt.
As first step, please refer to our [Development Conventions](https://github.com/FlowingCode/DevelopmentConventions) page to find information about Conventional Commits & Code Style requirements.

TwinColGrid Add-on was written by
- Felipe Lang
- Martin Lopez
Then, follow these steps for creating a contribution:

- Fork this project.
- Create an issue to this project about the contribution (bug or feature) if there is no such issue about it already. Try to keep the scope minimal.
- Develop and test the fix or functionality carefully. Only include minimum amount of code needed to fix the issue.
- For commit message, use [Conventional Commits](https://github.com/FlowingCode/DevelopmentConventions/blob/main/conventional-commits.md) to describe your change.
- Send a pull request for the original project.
- Comment on the original issue that you have implemented a fix for it.

## License & Author

This add-on is distributed under Apache License 2.0. For license terms, see LICENSE.txt.

TwinColGrid Add-on is written by Flowing Code S.A.