Skip to content

Conversation

@franrob-projects
Copy link
Contributor

@franrob-projects franrob-projects commented Jun 18, 2025

This PR streamlines and refocuses the content of README.md to improve readability, simplify navigation, and make ongoing maintenance easier.

Commits

EDU-1951: Adds header and shield

Adds a branded header image and clickable badge shields for version/license.

EDU-1951: Rewrites introduction and overview

Simplifies the intro and overview.

EDU-1951: Adds getting started

Adds a brief Getting started section linking to quickstart examples.

EDU-1951: Rewrites supported platforms section

Rewrites platform support using a table for clarity.

EDU-1951: Removes random docs section

Removes now redundant docs section.

EDU-1951: Removes install and usage section

Removes installation and usage instructions in favor docs links.

EDU-1951: Removes release process section

Drops internal release workflow from README.

EDU-1951: Adds EventMachine section

Adds section explaining EventMachine requirements and usage.

EDU-1951: Adds releases section

Add a Releases section with links to changelog and release history.

EDU-1951: Condenses contribute section

Trims contribution instructions and link to CONTRIBUTING.md.

EDU-1951: Condenses support section

Rewrite support section for clarity.

EDU-1951: Removes SDK info duplicate

Removes repeated SDK capability details already covered earlier.

EDU-1951: Adds install and usage section + new contribute.md file

Adds install and usage section and new contribute.md file.

Jira

https://ably.atlassian.net/browse/EDU-1951

@github-actions github-actions bot temporarily deployed to staging/pull/446/docs June 18, 2025 09:16 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/446/features June 18, 2025 09:16 Inactive
@franrob-projects franrob-projects changed the title Edu 1951 improve pub/sub ruby readme Edu 1951 Improves Pub/Sub Ruby Readme Jun 23, 2025
@github-actions github-actions bot temporarily deployed to staging/pull/446/docs June 23, 2025 11:29 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/446/features June 23, 2025 11:29 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/446/docs June 23, 2025 11:32 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/446/features June 23, 2025 11:32 Inactive
@franrob-projects franrob-projects force-pushed the EDU-1951-Improve-Pub/Sub-ruby-README branch from dd259d0 to eb3eefc Compare June 23, 2025 11:33
@github-actions github-actions bot temporarily deployed to staging/pull/446/features June 23, 2025 11:34 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/446/docs June 23, 2025 11:34 Inactive
@franrob-projects franrob-projects marked this pull request as ready for review June 23, 2025 11:40
@github-actions github-actions bot temporarily deployed to staging/pull/446/features July 21, 2025 15:01 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/446/docs July 21, 2025 15:02 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/446/docs July 21, 2025 15:33 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/446/features July 21, 2025 15:33 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/446/docs July 21, 2025 15:38 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/446/features July 21, 2025 15:38 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/446/features July 21, 2025 15:41 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/446/docs July 21, 2025 15:41 Inactive
@franrob-projects franrob-projects force-pushed the EDU-1951-Improve-Pub/Sub-ruby-README branch from 57b3120 to d9b60e0 Compare July 21, 2025 15:42
@github-actions github-actions bot temporarily deployed to staging/pull/446/docs July 21, 2025 15:42 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/446/features July 21, 2025 15:42 Inactive
EDU-1951: Adds getting started

EDU-1951: Rewrites introduction and overview

EDU-1951: Rewrites supported platforms section

EDU-1951: Removes random docs section

EDU-1951: Removes install and usage section

EDU-1951: Removes release process section

EDU-1951: Adds EventMachine section

EDU-1951: Adds releases section

EDU-1951: Condenses contribute section

EDU-1951: Condenses support section

EDU-1951: Removes SDK info duplicate

EDU-1951: Adds install and usage section + new contribute.md file

EDU-1951: Addresses reviewer feedback
@franrob-projects franrob-projects force-pushed the EDU-1951-Improve-Pub/Sub-ruby-README branch from d9b60e0 to abfc518 Compare July 21, 2025 15:45
@ttypic ttypic merged commit 365b036 into main Jul 21, 2025
19 of 23 checks passed
@ttypic ttypic deleted the EDU-1951-Improve-Pub/Sub-ruby-README branch July 21, 2025 18:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

3 participants