diff --git a/client-template/README.mustache b/client-template/README.mustache new file mode 100644 index 0000000..ef0edf0 --- /dev/null +++ b/client-template/README.mustache @@ -0,0 +1,57 @@ +# Rust API client for {{{packageName}}} + +> [!CAUTION] +> This whole client is generated. Please read README in top directory of repo. + +{{#appDescriptionWithNewLines}} +{{{.}}} +{{/appDescriptionWithNewLines}} + +{{#infoUrl}} +For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}}) +{{/infoUrl}} + +## Overview + +This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [openapi-spec](https://openapis.org) from a remote server, you can easily generate an API client. + +- API version: {{{appVersion}}} +- Package version: {{{packageVersion}}} +{{^hideGenerationTimestamp}} +- Build date: {{{generatedDate}}} +{{/hideGenerationTimestamp}} +- Generator version: {{generatorVersion}} +- Build package: `{{{generatorClass}}}` + +## Installation + +Put the package under your project folder in a directory named `{{packageName}}` and add the following to `Cargo.toml` under `[dependencies]`: + +``` +{{{packageName}}} = { path = "./{{{packageName}}}" } +``` + +## Documentation for API Endpoints + +All URIs are relative to *{{{basePath}}}* + +Class | Method | HTTP request | Description +------------ | ------------- | ------------- | ------------- +{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}*{{{classname}}}* | [**{{{operationId}}}**]({{{apiDocPath}}}{{classname}}.md#{{{operationIdLowerCase}}}) | **{{{httpMethod}}}** {{{path}}} | {{{summary}}} +{{/operation}}{{/operations}}{{/apis}}{{/apiInfo}} + +## Documentation For Models + +{{#models}}{{#model}} - [{{{classname}}}]({{{modelDocPath}}}{{{classname}}}.md) +{{/model}}{{/models}} + +To get access to the crate's generated documentation, use: + +``` +cargo doc --open +``` + +## Author + +{{#apiInfo}}{{#apis}}{{#-last}}{{{infoEmail}}} +{{/-last}}{{/apis}}{{/apiInfo}} \ No newline at end of file diff --git a/crates/tx-sitter-client/README.md b/crates/tx-sitter-client/README.md index 3732147..2c0aa56 100644 --- a/crates/tx-sitter-client/README.md +++ b/crates/tx-sitter-client/README.md @@ -1,5 +1,8 @@ # Rust API client for tx-sitter-client +> [!CAUTION] +> This whole client is generated. Please read README in top directory of repo. + A transaction relayer service! ## Operating a relayer @@ -91,4 +94,3 @@ cargo doc --open ## Author -