docs: Complete README.md rewrite for clarity and engagement #1552
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
Rewrote the main README.md to be simpler, more exciting, and easier for new developers to understand. Key changes include: - More engaging introduction and welcoming tone. - New "Quick Start" section for a fast first experience. - Reorganized and clarified installation instructions for npm, CDN, and Deno. - Updated "Explore Our JavaScript Toolkit for AI" section with current package names (e.g., @huggingface/agents), clearer descriptions, and links to individual package READMEs and npm pages. - Refined code examples for better readability and added more explanatory comments. - Ensured overall structure is logical and content is up-to-date. Note: Project-level format, lint, and test scripts are currently failing due to unrelated setup/dependency issues (missing prettier-plugin-svelte, ESLint v9 config, vitest not found). These do not affect the README changes.
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
|
(AI-generated test?) |
|
well: |
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.
Rewrote the main README.md to be simpler, more exciting, and easier for new developers to understand.
Key changes include:
Note: Project-level format, lint, and test scripts are currently failing due to unrelated setup/dependency issues (missing prettier-plugin-svelte, ESLint v9 config, vitest not found). These do not affect the README changes.