keith-turner commented on code in PR #51: URL: https://github.com/apache/accumulo-access/pull/51#discussion_r1488670395
########## README.md: ########## @@ -41,9 +41,34 @@ are package private and are not part of the public API. * [AccessExpression](src/main/java/org/apache/accumulo/access/AccessExpression.java). * [Authorizations](src/main/java/org/apache/accumulo/access/Authorizations.java). +## Getting Started + +Add the library to your CLASSPATH. For Maven, use: + +```xml +<dependencies> + <dependency> + <groupId>org.apache.accumulo</groupId> + <artifactId>accumulo-access</artifactId> + <version>$version</version> + </dependency> +</dependencies> +``` + +## Running the Example + +``` +mvn clean package +CLASSPATH=target/accumulo-access-$version.jar java src/test/java/example/AccessExample.java Review Comment: This makes it easier to run the command as is. ```suggestion CLASSPATH=$(ls target/accumulo-access-*.jar) java src/test/java/example/AccessExample.java ``` ########## README.md: ########## @@ -41,9 +41,34 @@ are package private and are not part of the public API. * [AccessExpression](src/main/java/org/apache/accumulo/access/AccessExpression.java). * [Authorizations](src/main/java/org/apache/accumulo/access/Authorizations.java). +## Getting Started + +Add the library to your CLASSPATH. For Maven, use: + +```xml +<dependencies> + <dependency> + <groupId>org.apache.accumulo</groupId> + <artifactId>accumulo-access</artifactId> + <version>$version</version> + </dependency> +</dependencies> +``` + +## Running the Example Review Comment: It would be nice to link to the example in the readme so its easy to jump to when browsing on GH. Not sure how linking in a markdown header looks though. ```suggestion ## Running the [Example](src/test/java/example/AccessExample.java) ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
