Skip to content
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.

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

Update README #1057

Merged
merged 5 commits into from
Nov 4, 2023
Merged

Update README #1057

merged 5 commits into from
Nov 4, 2023

Conversation

syall
Copy link
Contributor

@syall syall commented Oct 27, 2023

Issue #, if available:

N/A.

Description of changes:

Update README with:

  • how to get started with Smithy TypeScript code generators
  • document generated output
  • document plugin configuration
  • how to customize code generation and clients
  • get started with local development

And other quality of life fixes.

If one or more of the packages in the /packages directory has been modified, be sure yarn changeset add has been run and its output has
been committed and included in this pull request. See CONTRIBUTING.md.


By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@syall syall force-pushed the update-readme branch 4 times, most recently from b126bd3 to 1ac660c Compare November 2, 2023 21:45
@syall syall force-pushed the update-readme branch 2 times, most recently from c2ccf33 to 0086542 Compare November 2, 2023 23:10
@syall syall force-pushed the update-readme branch 5 times, most recently from bde0e39 to 85b4deb Compare November 3, 2023 15:58
@syall syall marked this pull request as ready for review November 3, 2023 17:04
@syall syall requested review from a team as code owners November 3, 2023 17:04
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
```kotlin
plugins {
id("java-library")
id("software.amazon.smithy.gradle.smithy-jar").version("0.8.0")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we just need the smithy-base plugin here b/c we dont actually care about the generated jar.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was from the quickstart-gradle template, so I don't think it makes sense to go into that much detail for a quick start.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should make sure when we add the new example templates for this repo they use the correct plugin. This one is not correct for this use case.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
@syall syall force-pushed the update-readme branch 4 times, most recently from a43a165 to e3eb40f Compare November 3, 2023 19:45
@syall syall merged commit 7d37686 into smithy-lang:main Nov 4, 2023
7 checks passed
@syall syall deleted the update-readme branch November 4, 2023 05:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants