Skip to content

Commit 204f923

Browse files
committed
add license and update readme
1 parent d96c3d4 commit 204f923

2 files changed

Lines changed: 16 additions & 6 deletions

File tree

license.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Copyright About Bits GmbH
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
4+
5+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
6+
7+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

readme.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,21 @@
22

33
A collection of GitHub actions for Java projects.
44

5-
## Example Playbook
5+
## Setup Java and Update Dependencies
6+
This action will set up the Java SDK and initialize the cache for Maven dependencies. It will then install or update all dependencies.
7+
8+
### Example
69

710
```yaml
8-
- name: Build code
9-
uses: aboutbits/github-actions-java/xxx@v1
10-
with:
11-
xxx-version: ${{ env.NODE_VERSION }}
11+
- name: Checkout source code
12+
uses: actions/checkout@v3
13+
14+
- uses: aboutbits/github-actions-java/setup-java-and-update-dependencies
1215
```
1316
1417
## Versioning
1518
16-
In order to have a verioning in place and working, create leightweight tags that point to the appropriate minor release versions.
19+
In order to have a versioning in place and working, create lightweight tags that point to the appropriate minor release versions.
1720
1821
Creating a new minor release:
1922

0 commit comments

Comments
 (0)