diff --git a/README.md b/README.md index 3cf7d4d1..94ace807 100644 --- a/README.md +++ b/README.md @@ -31,4 +31,52 @@ For additional client implementations in other languages, see: For more information, see [the nailgun website](https://github.com/facebook/nailgun). +## Additional information +### Example usage + +```bash +$ ./nailgun-client/target/ng com.facebook.nailgun.examples.ThreadTest +``` + +### Logging + +To enable logging, start the server with `-Djava.util.logging.config.file="logging.properties"`. A relative file path is resolved in respect to the working directory +(i.e. system property `user.dir`). An example file is at `nailgun-server/src/main/resources/logging.properties` but will only be used if (soft-) linked appropriate. + +### Aliases + +* Aliases are loaded from `com/facebook/nailgun/builtins/builtins.properties` +* Adding an alias example: + ```bash + $ ./nailgun-client/target/ng ng-alias test com.facebook.nailgun.examples.ThreadTest + $ ./nailgun-client/target/ng test + ``` + +#### Built-in aliases + +```bash +$ ./nailgun-client/target/ng ng-alias +ng-alias com.facebook.nailgun.builtins.NGAlias + Displays and manages command aliases + +ng-cp com.facebook.nailgun.builtins.NGClasspath + Displays and manages the current system classpath + +ng-stats com.facebook.nailgun.builtins.NGServerStats + Displays nail statistics + +ng-stop com.facebook.nailgun.builtins.NGStop + Shuts down the nailgun server + +ng-version com.facebook.nailgun.builtins.NGVersion + Displays the server version number. +``` + +The alias `ng-cp` is _very_ dangerous and YOU are encouraged to set +`com.facebook.nailgun.builtins.NGClasspath.ALLOW_CLASSPATH_MODIFICATION` to +`false`. + +### Links + +* [original homepage](http://www.martiansoftware.com/nailgun/)