Skip to content

Commit f3e467f

Browse files
authored
Update README.md
Cleaned up formatting and updated information about Web API vs. DD testing.
1 parent c528c90 commit f3e467f

File tree

1 file changed

+20
-10
lines changed

1 file changed

+20
-10
lines changed

README.md

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,30 +11,40 @@ as well as an automated RESO Certification testing tool.
1111
# Getting Started
1212
To begin using the RESO Commander, choose one of the following topics:
1313

14-
## [RESO Certification](/doc/Certification.md)
15-
One of the Commander's primary uses is as an automated testing tool. This section
16-
explains how to run the following tests:
14+
## RESO Certification
15+
The RESO Commander is only used for Web API Core testing and will be deprecated in the future in favor of the RESO SDK.
1716

18-
* Data Dictionary
19-
* Web API Core
17+
[**MORE INFO**](/doc/Certification.md)
2018

21-
**Note**: Data Dictionary testing is now handled by the [**RESO Certification Utils**](https://github.com/RESOStandards/reso-certification-utils) command-line utility. The Commander still works for metadata validation, but will be retired in the near future and the new tools merged into this repository.
19+
_For Data Dictionary certification, see [**RESO Certification Utils**](https://github.com/RESOStandards/reso-certification-utils?tab=readme-ov-file#reso-data-dictionary-certification)._
2220

23-
## [Command-Line OData Web API Tools](/doc/CLI.md)
21+
## Command-Line OData Web API Tools
2422
The RESO Commander contains command line tools for working with OData Web APIs.
2523
This section covers how to validate metadata, make requests, and generate sample requests for testing.
2624

27-
## [Web API Client Library](/doc/ODataClient.md)
25+
[**MORE INFO**](/doc/CLI.md)
26+
27+
## Web API Client Library
2828
The RESO Commander offers a convenient wrapper around the Apache Olingo Java client for OData,
2929
with added support for OAuth2 Bearer Tokens and Client Credentials.
3030

3131
The client library can be used to fetch and validate metadata, fetch data, and perform other
3232
OData client tasks.
3333

34-
## [Docker](/doc/Docker.md)
34+
[**MORE INFO**]((/doc/ODataClient.md))
35+
36+
## Docker
3537
For those who prefer Docker, both the Command Line and Automated Testing Tools can be
3638
run in a Docker container.
3739

38-
## [Codegen](/doc/Codegen.md)
40+
[**MORE INFO**](/doc/Docker.md)
41+
42+
## Codegen
3943
The RESO Commander may also be used to generate reference XML Metadata, DDL, database seeds,
4044
automated acceptance tests, reference server models, and to convert XML Metadata to Open API 3 format.
45+
46+
[**MORE INFO**](/doc/Codegen.md)
47+
48+
---
49+
50+
[**Questions? Contact RESO**](mailto:[email protected])

0 commit comments

Comments
 (0)