Jelajahi Sumber

Clarified the information about utils in the README

Karel Minarik 12 tahun lalu
induk
melakukan
1f33e79345
1 mengubah file dengan 9 tambahan dan 3 penghapusan
  1. 9 3
      rest-api-spec/README.markdown

+ 9 - 3
rest-api-spec/README.markdown

@@ -46,9 +46,15 @@ The specification contains:
 The `methods` and `url.paths` elements list all possible HTTP methods and URLs for the endpoint;
 it is the responsibility of the developer to use this information for a sensible API on the target platform.
 
-The repository contains a utility script in Ruby which will scan and parse the Elasticsearch source code
-to extract the information from the Java source files. Run `bundle install` and then `thor help api:generate:spec`
-in the _utils_ folder.
+# Utilities
+
+The repository contains some utilities in the `utils` directory:
+
+* The `thor api:generate:spec` will generate the basic JSON specification from Java source code
+* The `thor api:generate:code` generates Ruby source code and tests from the specs, and can be extended
+  to generate assets in another programming language
+
+Run `bundle install` and then `thor list` in the _utils_ folder.
 
 ## License