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: Update boa's main README.md #3650

Merged
merged 1 commit into from
Feb 3, 2024
Merged

Docs: Update boa's main README.md #3650

merged 1 commit into from
Feb 3, 2024

Conversation

nekevss
Copy link
Member

@nekevss nekevss commented Feb 3, 2024

This PR is to update the main README.md for boa.

Occasionally, we still receive issues from someone using the Boa crate, so this is mostly attempting to add some clarity to the main README for which crates boa-dev currently maintains as well as adding an initial walkthrough example for anyone who stops by the repo.

It changes the following:

  • Adds Boa Crates section
  • Adds Boa Engine Example
  • Adds Documentation section for links to both the latest release and main.

@nekevss nekevss added the documentation update documentation label Feb 3, 2024
@nekevss nekevss requested a review from a team February 3, 2024 00:43
Copy link

github-actions bot commented Feb 3, 2024

Test262 conformance changes

Test result main count PR count difference
Total 96,422 96,422 0
Passed 80,939 80,939 0
Ignored 3,567 3,567 0
Failed 11,916 11,916 0
Panics 0 0 0
Conformance 83.94% 83.94% 0.00%

@nekevss nekevss added this to the v0.18.0 milestone Feb 3, 2024
@nekevss nekevss added the waiting-on-review Waiting on reviews from the maintainers label Feb 3, 2024
Copy link
Member

@jedel1043 jedel1043 left a comment

Choose a reason for hiding this comment

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

Really liking the new README!

@nekevss nekevss requested a review from a team February 3, 2024 20:34
Copy link
Member

@HalidOdat HalidOdat left a comment

Choose a reason for hiding this comment

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

I like the new README! Looks good to me! :)

@HalidOdat HalidOdat added this pull request to the merge queue Feb 3, 2024
Merged via the queue into main with commit 1e19003 Feb 3, 2024
13 checks passed
@jedel1043 jedel1043 deleted the update-readme-docs branch February 3, 2024 22:28
@jedel1043 jedel1043 removed the waiting-on-review Waiting on reviews from the maintainers label Sep 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation update documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants