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

docs: Create a README and getting started guide #34

Merged
merged 26 commits into from
Oct 10, 2023
Merged

Conversation

bhelx
Copy link
Contributor

@bhelx bhelx commented Sep 30, 2023

An attempt at a README for the PDKs. Should have a similar treatment to the SDKs. It should walk the user through the different high level features. It should link up to the concept docs and down to the ref docs to teach them how to find both.

@bhelx bhelx marked this pull request as ready for review October 5, 2023 15:51
@@ -14,7 +14,7 @@ serde = { version = "1", features = ["derive"] }
serde_json = "1"
extism-pdk-derive = {path = "./derive", version = "0.3.1"}
extism-manifest = {version = "0.5.0", optional = true}
extism-convert = {git = "https://github.com/extism/extism", version = "0.1"} # TODO: change this after extism-convert has been released
extism-convert = { version = "0.2"}
Copy link
Contributor Author

Choose a reason for hiding this comment

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

went ahead and updated this now that it's published

Copy link
Contributor

@zshipko zshipko left a comment

Choose a reason for hiding this comment

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

Just a few suggestions, but otherwise looks good!

README.md 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
@bhelx bhelx merged commit 7de1b46 into main Oct 10, 2023
2 checks passed
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