Revamp README: add elevator pitch, TOC, schema, requirements, performance, and compatibility#3
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
Description
README.mdto add an elevator pitch and a single-line USP directly under the project title.Supported Markdown constructs,Requirements(Python >= 3.12),Output/Metadata schema,Performance/Scalability, andCompatibility(Dify/n8n/Windmill).metadatashape and called out streaming APIs such aschunk_file_streaming()/chunk_stream()for large-file workflows.Testing
README.mdwas performed to ensure section ordering and anchors are correct.Codex Task