Update readme and pom

0x4a616e · Nov 21, 2020 · 12bdaf0 · 12bdaf0
1 parent 3f053e2
commit 12bdaf0
Show file tree

Hide file tree

Showing 2 changed files with 43 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -2,4 +2,24 @@
 
 Java Foundation Access is a pure Java library for accessing Apples Foundation framework.
 
-Access is done purely using JNA. Foundation classes are based on classes from IntelliJ Community Edition https://github.com/JetBrains/intellij-community 
+Access is done purely using JNA. Foundation classes are based on classes from IntelliJ Community Edition https://github.com/JetBrains/intellij-community 
+
+# Usage
+
+Add maven dependency
+
+```xml
+<dependency>
+  <groupId>de.jangassen</groupId>
+  <artifactId>jfa</artifactId>
+  <version>1.0</version>
+</dependency>
+```
+
+Simple example of accessing NSApplication:
+
+```java
+NSMenu menu = NSMenu.alloc().initWithTitle("Title");
+// add more items...
+NSApplication.sharedApplication().setMainMenu(menu);
+```
diff --git a/pom.xml b/pom.xml
@@ -6,7 +6,28 @@
 
     <groupId>de.jangassen</groupId>
     <artifactId>jfa</artifactId>
-    <version>1.0-SNAPSHOT</version>
+    <version>1.0</version>
+    <name>JFA</name>
+    <description>Java Foundation Access</description>
+    <url>https://github.com/0x4a616e/jfa</url>
+    <developers>
+        <developer>
+            <id>jan.gassen</id>
+            <name>Jan Gassen</name>
+        </developer>
+    </developers>
+
+    <licenses>
+        <license>
+            <name>Apache 2.0</name>
+            <url>https://opensource.org/licenses/Apache-2.0</url>
+            <distribution>repo</distribution>
+        </license>
+    </licenses>
+
+    <scm>
+        <url>https://github.com/0x4a616e/jfa</url>
+    </scm>
 
     <build>
         <plugins>