Skip to content

Commit d87f3f7

Browse files
authored
Update ReadMe
Added a few new sections to meet ReadMe Standards
1 parent f37970f commit d87f3f7

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
1-
# java-example
2-
Examples for OpenFin Java adapter
1+
# Java Adapter Example
32

4-
## Run the example of connecting to OpenFin and creating applications
3+
## Overview
4+
The following repo contains examples for OpenFin's Java adapter.
5+
6+
## Guidelines
7+
Run the example of connecting to OpenFin and creating applications
58

69
1. Clone this repository
710

@@ -133,9 +136,12 @@ Source code for the example is located in /src/main/java/com/openfin/desktop/dem
133136
Once the demo is running, Windows snap while being draggted close to other windows. Snapped windows dock on mounse release.
134137

135138
## More Info
136-
137139
More information and API documentation can be found at https://openfin.co/java-api/
138140

139-
## Getting help
141+
## Disclaimers
142+
* This is a starter example and intended to demonstrate to app providers a sample of how to approach an implementation. There are potentially other ways to approach it and alternatives could be considered.
143+
* Its possible that the repo is not actively maintained.
140144

141-
Please contact [email protected]
145+
## Support
146+
Please enter an issue in the repo for any questions or problems.
147+
<br> Alternatively, please contact us at [email protected]

0 commit comments

Comments
 (0)