-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix(readme): Updated readme to support single source for documentation (
#42) Signed-off-by: Muskan Bararia <muskan.b@docusign.com> Co-authored-by: Muskan Bararia <muskan.b@docusign.com>
- Loading branch information
1 parent
3263a0d
commit 0cd6e4f
Showing
1 changed file
with
45 additions
and
91 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,120 +1,74 @@ | ||
| # Concerto CLI | ||
|
|
||
| Command line tool for Concerto. | ||
| [](https://discord.gg/Zm99SKhhtA/) | ||
|
|
||
| ## Usage | ||
| This repository contains the CLI interface to test, edit, compile and update Concerto Models. | ||
|
|
||
| ``` | ||
| concerto <cmd> [args] | ||
| Commands: | ||
| concerto validate validate JSON against model files | ||
| concerto compile generate code for a target platform | ||
| concerto get save local copies of external model dependencies | ||
| Options: | ||
| --version Show version number [boolean] | ||
| --verbose, -v [default: false] | ||
| --help Show help [boolean] | ||
| ``` | ||
|
|
||
| ### Concerto validate | ||
|
|
||
| The `validate` command lets you check whether a JSON input is a valid instance of the given model. | ||
|
|
||
| ``` | ||
| concerto validate | ||
| validate JSON against model files | ||
| Options: | ||
| --version Show version number [boolean] | ||
| --verbose, -v [default: false] | ||
| --help Show help [boolean] | ||
| --input JSON to validate [string] | ||
| --model array of concerto (cto) model files [array] | ||
| --offline do not resolve external models [boolean] [default: false] | ||
| --functional new validation API [boolean] [default: false] | ||
| ``` | ||
| ### Documentation | ||
|
|
||
| ### Concerto compile | ||
| The command set exposed by this repository is described at [cli-docs](https://concerto.accordproject.org/docs/tools/ref-concerto-cli). | ||
|
|
||
| The `compile` command takes an array of local CTO files, download any external dependencies (imports) and then convert all the model in the `ModelManager` to the target format. | ||
|
|
||
| ``` | ||
| concerto compile | ||
| generate code for a target platform | ||
| Options: | ||
| --version Show version number [boolean] | ||
| --verbose, -v [default: false] | ||
| --help Show help [boolean] | ||
| --model array of concerto (cto) model files [array] [required] | ||
| --offline do not resolve external models [boolean] [default: false] | ||
| --target target of the code generation [string] [default: "JSONSchema"] | ||
| --output output directory path [string] [default: "./output/"] | ||
| ``` | ||
| <p align="center"> | ||
| <a href="https://www.accordproject.org/"> | ||
| <img src="assets/APLogo.png" alt="Accord Project Logo" width="400" /> | ||
| </a> | ||
| </p> | ||
|
|
||
| #### Go Lang | ||
|
|
||
| ``` | ||
| concerto compile --model modelfile.cto --target Go | ||
| ``` | ||
| <p align="center"> | ||
| <a href="./LICENSE"> | ||
| <img src="https://img.shields.io/github/license/accordproject/cicero?color=bright-green" alt="GitHub license"> | ||
| </a> | ||
| <a href="https://accord-project-slack-signup.herokuapp.com/"> | ||
| <img src="https://img.shields.io/badge/Accord%20Project-Join%20Slack-blue" alt="Join the Accord Project Slack"/> | ||
| </a> | ||
| </p> | ||
|
|
||
| #### Plant UML | ||
| Accord Project is an open source, non-profit, initiative working to transform contract management and contract automation by digitizing contracts. Accord Project operates under the umbrella of the [Linux Foundation][linuxfound]. The technical charter for the Accord Project can be found [here][charter]. | ||
|
|
||
| ``` | ||
| concerto compile --model modelfile.cto --target PlantUML | ||
| ``` | ||
| ## Learn More About Accord Project | ||
|
|
||
| #### Typescript | ||
| ### [Overview][apmain] | ||
|
|
||
| ``` | ||
| concerto compile --model modelfile.cto --target Typescript | ||
| ``` | ||
| ### [Documentation][apdoc] | ||
|
|
||
| #### Rust | ||
| ## Contributing | ||
|
|
||
| ``` | ||
| concerto compile --model modelfile.cto --target Rust | ||
| ``` | ||
| The Accord Project technology is being developed as open source. All the software packages are being actively maintained on GitHub and we encourage organizations and individuals to contribute requirements, documentation, issues, new templates, and code. | ||
|
|
||
| #### Java | ||
| Find out what’s coming on our [blog][apblog]. | ||
|
|
||
| ``` | ||
| concerto compile --model modelfile.cto --target Java | ||
| ``` | ||
| Join the Accord Project Technology Working Group [Discord channel][apdisc] to get involved! | ||
|
|
||
| #### JSONSchema | ||
| For code contributions, read our [CONTRIBUTING guide][contributing] and information for [DEVELOPERS][developers]. | ||
|
|
||
| ``` | ||
| concerto compile --model modelfile.cto --target JSONSchema | ||
| ``` | ||
| ### README Badge | ||
|
|
||
| #### XMLSchema | ||
| Using Accord Project? Add a README badge to let everyone know: [](https://www.accordproject.org/) | ||
|
|
||
| ``` | ||
| concerto compile --model modelfile.cto --target XMLSchema | ||
| [](https://www.accordproject.org/) | ||
| ``` | ||
|
|
||
| ### Concerto Get | ||
| ## License <a name="license"></a> | ||
|
|
||
| The `get` command allows you to resolve and download external models from a set of local CTO files. | ||
| Accord Project source code files are made available under the [Apache License, Version 2.0][apache]. | ||
| Accord Project documentation files are made available under the [Creative Commons Attribution 4.0 International License][creativecommons] (CC-BY-4.0). | ||
|
|
||
| ``` | ||
| concerto get | ||
| Copyright 2018-2019 Clause, Inc. All trademarks are the property of their respective owners. See [LF Projects Trademark Policy](https://lfprojects.org/policies/trademark-policy/). | ||
|
|
||
| save local copies of external model dependencies | ||
| [linuxfound]: https://www.linuxfoundation.org | ||
| [charter]: https://github.com/accordproject/governance/blob/master/accord-project-technical-charter.md | ||
| [apmain]: https://accordproject.org/ | ||
| [apblog]: https://medium.com/@accordhq | ||
| [apdoc]: https://docs.accordproject.org/ | ||
| [apslack]: https://accord-project-slack-signup.herokuapp.com | ||
| [apdisc]: https://discord.gg/Zm99SKhhtA | ||
|
|
||
| Options: | ||
| --version Show version number [boolean] | ||
| --verbose, -v [default: false] | ||
| --help Show help [boolean] | ||
| --model array of concerto (cto) model files [array] [required] | ||
| --output output directory path [string] [default: "./"] | ||
| ``` | ||
| [storybook]: https://ap-web-components.netlify.app/ | ||
|
|
||
| ## License <a name="license"></a> | ||
| Accord Project source code files are made available under the Apache License, Version 2.0 (Apache-2.0), located in the LICENSE file. Accord Project documentation files are made available under the Creative Commons Attribution 4.0 International License (CC-BY-4.0), available at http://creativecommons.org/licenses/by/4.0/. | ||
| [contributing]: https://github.com/accordproject/web-components/blob/master/CONTRIBUTING.md | ||
| [developers]: https://github.com/accordproject/web-components/blob/master/DEVELOPERS.md | ||
|
|
||
| [apache]: https://github.com/accordproject/web-components/blob/master/LICENSE | ||
| [creativecommons]: http://creativecommons.org/licenses/by/4.0/ |