Skip to content

docs: update README for missing info #1939

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

Merged
merged 12 commits into from
Jun 10, 2025
Merged

docs: update README for missing info #1939

merged 12 commits into from
Jun 10, 2025

Conversation

rishav-karanjit
Copy link
Member

@rishav-karanjit rishav-karanjit commented Jun 9, 2025

Issue #, if available:

Description of changes:
Update README to add:

  1. Rust to supported language (will add Go later near to the release)
  2. Point the readme in ./DynamoDbEncryption/README.md for code organization and development.
  3. Make testvectors build instructions better and add Go build instructions to it

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

@rishav-karanjit rishav-karanjit requested a review from a team as a code owner June 9, 2025 18:01
@rishav-karanjit rishav-karanjit changed the title docs: update README for missing info docs: update README for missing info Jun 9, 2025
@@ -48,7 +48,7 @@ This repository is a top level repository which houses all source code in order
different runtimes.

This library is written in Dafny, a formally verifiable programming language that can be compiled into
different runtimes. This library is currently **ONLY** supported in Java and .NET
different runtimes. This library is currently **ONLY** supported in Java, .NET and Rust.
Copy link
Member Author

Choose a reason for hiding this comment

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

Will add Go later when we get close to the release

Copy link
Contributor

@seebees seebees left a comment

Choose a reason for hiding this comment

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

LGTM

@rishav-karanjit rishav-karanjit merged commit 354f4f6 into main Jun 10, 2025
83 of 90 checks passed
@rishav-karanjit rishav-karanjit deleted the ReadMeUpdate branch June 10, 2025 23:09
lucasmcdonald3 pushed a commit that referenced this pull request Jun 25, 2025
## [3.9.0](v3.8.1...v3.9.0) (2025-06-25)

### Features

* **Go:** support DB-ESDK in Go ([#1861](#1861)) ([56821de](56821de))

### Maintenance

* **CI:** Fix Dafny CLI CI error ([#1910](#1910)) ([97fe459](97fe459))
* **dafny:** Add ExecuteStatement test  ([#1932](#1932)) ([66a19ab](66a19ab))
* **dafny:** Add Update and delete test  ([#1942](#1942)) ([3bd48ba](3bd48ba))
* **dafny:** bump mpl version ([#1933](#1933)) ([0ebc112](0ebc112))
* **dafny:** change nat to uint64 in many places ([#1852](#1852)) ([ec22b7d](ec22b7d))
* **dafny:** further performance enhancements ([#1834](#1834)) ([ea94693](ea94693))
* **dafny:** improve performance ([#1900](#1900)) ([ccf61d6](ccf61d6))
* **dafny:** improve performance of searchable encryption ([#1931](#1931)) ([8b71004](8b71004))
* **dafny:** reduce use of BigInteger ([#1872](#1872)) ([eb7679a](eb7679a))
* **dafny:** test ExecuteTransaction and BatchExecuteStatement ([#1941](#1941)) ([69c37c6](69c37c6))
* **deps:** Bump MPL version to 1.11.0 ([#1945](#1945)) ([efdd373](efdd373))
* **dotnet:** copy all the JSON for testvectors CI  ([#1921](#1921)) ([58b39a7](58b39a7))
* fix Java release script  ([#1944](#1944)) ([ada96d7](ada96d7))
* further performance improvements ([#1826](#1826)) ([3194054](3194054))
* **go:** add item encryptor and misc examples  ([#1873](#1873)) ([45ec157](45ec157))
* **go:** fix restore logic for polymorph copied code ([#1935](#1935)) ([e2d76c3](e2d76c3))
* **go:** Update code generation CI to check Go polymorph code  ([#1936](#1936)) ([6e1e48c](6e1e48c))
* improve performance ([#1622](#1622)) ([8ca2883](8ca2883))
* install smithy-dafny dependencies in github workflows ([#1890](#1890)) ([fc64e62](fc64e62))
* **java:** allow local testing ([#1779](#1779)) ([42be20b](42be20b))
* **java:** Parallelize Java Examples ([#1940](#1940)) ([b532564](b532564))
* restore static test branch key id ([#1790](#1790)) ([c67e3c9](c67e3c9))
* run test vectors in net and java on MacOS ([#1844](#1844)) ([10f530b](10f530b))
* **rust:** get latest fixes for dafny-runtime-rust ([#1924](#1924)) ([245ad31](245ad31))
* **rust:** prepare 1.1.1 release ([#1937](#1937)) ([6173888](6173888))
* **rust:** Rust release version 1.1.0 ([#1885](#1885)) ([f2997be](f2997be))
* **rust:** update dafny runtime release ([#1884](#1884)) ([0e4fd02](0e4fd02))
* **TestVectors:** Test Smithy-generated ItemEncryptor ([#1814](#1814)) ([ba9caca](ba9caca))
* update README for missing info  ([#1939](#1939)) ([354f4f6](354f4f6))
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.

2 participants