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.

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

Update spelling in docs #73

Merged
merged 2 commits into from
Jan 24, 2022
Merged

Update spelling in docs #73

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0b6abd1
spelling
msinton Jan 24, 2022
197fd51
Update wording, derive over synthetize
msinton Jan 24, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions modules/docs/src/01-overview/01-intro.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ title: Intro
smithy4s is a tool that generates third-party-free, protocol-agnostic scala code from smithy specifications.

Smithy4s can be used to:
* quickly synthetise http/rest servers and clients
* synthetise pure-scala AWS clients
* synthetise CLI tools
* quickly derive http/rest servers and clients
* derive pure-scala AWS clients
* derive CLI tools
* and has the potential for much, much more!

2 changes: 1 addition & 1 deletion modules/docs/src/03-protocols/02-simple-rest-json/01-overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: The SimpleRestJson protocol

Smithy4s provides a custom Json-in/Json-out protocol that smithy services can be annotated with.

Smithy4s comes with opt-in http4s-specific module, that contains functions that are aware of this protocol, and can be used to quickly synthetise http services and clients.
Smithy4s comes with opt-in http4s-specific module, that contains functions that are aware of this protocol, and can be used to quickly derive http services and clients.

As for the json aspect of the protocol, [jsoniter-scala](https://github.com/plokhotnyuk/jsoniter-scala/) is used for the (de)serialisation of the http bodies.

Expand Down