Skip to content

http-client-java, generate README for guide of the usage of generated lib #7058

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
3 tasks done
weidongxu-microsoft opened this issue Apr 21, 2025 · 0 comments · Fixed by #7177
Closed
3 tasks done

http-client-java, generate README for guide of the usage of generated lib #7058

weidongxu-microsoft opened this issue Apr 21, 2025 · 0 comments · Fixed by #7177
Labels
emitter:client:java Issue for the Java client emitter: @typespec/http-client-java

Comments

@weidongxu-microsoft
Copy link
Contributor

Clear and concise description of the problem

feature #6639

The README targets the user of the lib (not the user of the emitter).

It could be similar to what we did for mgmt lib (but a simpler one)
https://github.com/microsoft/typespec/blob/main/packages/http-client-java/generator/http-client-generator-mgmt/src/main/resources/Readme.txt

Checklist

  • Follow our Code of Conduct
  • Read the docs.
  • Check that there isn't already an issue that request the same feature to avoid creating a duplicate.
@weidongxu-microsoft weidongxu-microsoft added the emitter:client:java Issue for the Java client emitter: @typespec/http-client-java label Apr 21, 2025
@weidongxu-microsoft weidongxu-microsoft mentioned this issue Apr 30, 2025
Merged
github-merge-queue bot pushed a commit that referenced this issue May 12, 2025
@weidongxu-microsoft
http-client-java, generate readme.md for unbranded, prepare patch rel…
52644f5 
…ease (#7177)

Update: also include a fix, that POM.xml is not generated in unbranded

fix #7058

generate a simple readme.md
```
# Builtin client library for Java

Builtin client library for Java.

This package contains Builtin client library.

## Getting started

### Prerequisites

- [Java Development Kit (JDK)][jdk] with version 8 or above

### Adding the package to your product

<dependency>
    <groupId>io.clientcore</groupId>
    <artifactId>tsptest-builtin</artifactId>
    <version>1.0.0-beta.1</version>
</dependency>

<!-- LINKS -->
[jdk]: https://learn.microsoft.com/azure/developer/java/fundamentals/
```
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
emitter:client:java Issue for the Java client emitter: @typespec/http-client-java
Projects
None yet
Milestone
No milestone
1 participant
@weidongxu-microsoft