committing update to read me file #2
Conversation
README.md
Outdated
|
|
||
|
|
||
| #####EndPoints | ||
| ##### EndPoints | ||
| The kdb-rest-service provides two endpoints:executeFunction and executeQuery. | ||
|
|
||
| The executeFunction provides a means to call a predefined function and pass parameters to the kdb instance. | ||
| For example this is the format of a request call a function called plus which passes two arguments labelled "xarg" and "yarg" with values 96.3 and 9.7: | ||
|
|
||
| e.g. | ||
| { |
There was a problem hiding this comment.
opening and closing { should be in code blocks as well
README.md
Outdated
| The requests are sent in HTTPS format and to provide this the project has a self-signed certifiate embedded within. It is strongly recommended that you add your own certificate. Updating the certificate will require and update to the following properties in application.properties: | ||
|
|
||
| security.require-ssl=true | ||
| security.require-ssl=true | ||
|
|
There was a problem hiding this comment.
I'd get rid of all these blank lines between each property, they're not needed inside code blocks (same in earlier section)
README.md
Outdated
|
|
||
| There is a DockerFile within the project for deploying the project on docker. | ||
|
|
||
| Alternatively it can be run locally by providing the appropriate build configuration via command line or ide. | ||
|
|
||
| ##Built with | ||
| ## Built with |
There was a problem hiding this comment.
Does this need a full section? Seems weird to have a section where title is longer than the full section
README.md
Outdated
| Maven | ||
|
|
||
| ##Licensing | ||
| ## Licensing | ||
| Please see license file. |
There was a problem hiding this comment.
Does this need to be said? github displays license pretty prominently in the info bar at the top of the repo
README.md
Outdated
| Please see license file. | ||
|
|
||
| ##Contributing | ||
| ## Contributing | ||
| The branch is currently locked down and will require a pull request reviewed by a member of the aquaq team before any changes can be committed. |
README.md
Outdated
|
|
||
| These value are provided within the header of the request, it is strongly recommended to invoke your own security if you use the project. | ||
|
|
||
|
|
||
| ##Deploying | ||
| ## Deploying | ||
|
|
||
| There is a DockerFile within the project for deploying the project on docker. | ||
|
|
||
| Alternatively it can be run locally by providing the appropriate build configuration via command line or ide. |
README.md
Outdated
| } | ||
|
|
||
| #####Certificates | ||
| ##### Certificates | ||
| The requests are sent in HTTPS format and to provide this the project has a self-signed certifiate embedded within. It is strongly recommended that you add your own certificate. Updating the certificate will require and update to the following properties in application.properties: |
There was a problem hiding this comment.
"will require and update" -> an update
also is application.properties a filename? I think it's generally nicer to have filenames as inline code e.g. application.properties (wrap it in ` to do this)
README.md
Outdated
| @@ -1,80 +1,87 @@ | |||
| #kdb-rest-service | |||
| # kdb-rest-service | |||
|
|
|||
| This is an open source rest service written in java which can be used to connect to an instance of kdb using json. The rest service can provide a single query to run or call a function predefined on the instance of kdb. | |||
There was a problem hiding this comment.
I'd remove "This is" and start with "An open source..."; the "this is" adds nothing IMO and I think it's advantageous to keep the description as brief as possible
possibly also capitalise JSON & REST given they are abbreviations?
README.md
Outdated
| ## Contributing | ||
| The branch is currently locked down and will require a pull request reviewed by a member of the AQUAQ team before any changes can be committed. |
No description provided.