Skip to content

Rewrite the README around how the repository fits together - #37

Open
magic-peach wants to merge 1 commit into
runtimeconditions:mainfrom
magic-peach:docs/readme-rewrite
Open

magic-peach wants to merge 1 commit into
runtimeconditions:mainfrom
magic-peach:docs/readme-rewrite

Conversation

@magic-peach

Copy link
Copy Markdown
Member

Summary

Rewrites README.md so a newcomer can tell what the repository is for and how its parts connect. The previous README listed the extensions and the Go bindings, but did not explain how extensions, bindings, profilers, profiles, and platforms relate.

The README now has:

  • a short description of Runtime Conditions and of this repository;
  • "How it fits together", with a diagram of the path from extension definition to platform;
  • an example that follows one Redis cache from the Common Integrations definition, through a Go declaration, to the resulting profile;
  • "What's in this repository", which describes every top-level folder and includes a diagram of how bindings are produced;
  • Status and Bindings columns in the extensions table, with each status taken from the extension's own README;
  • install commands and minimal examples for Go, TypeScript, and Python;
  • a Contributing section that points to CONTRIBUTING.md.

Add an overview of how extensions, bindings, profilers and platforms
connect, a Redis cache example followed from extension to profile, a
description of every top-level folder with a diagram of binding
generation, status and bindings columns in the extensions table, and
TypeScript and Python usage next to Go. Correct the Source Control
identifier and list the current Amazon S3 release.
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.

1 participant