Skip to content

Conversation

@leighmcculloch
Copy link
Member

@leighmcculloch leighmcculloch commented May 20, 2025

What

Update README to reflect current project status and usage guidance.

Why

The readme is out of date and doesn't capture what the recommended way to use and contribute the tooling.

cc @stellar/platform-eng

@leighmcculloch leighmcculloch requested a review from dmkozh May 20, 2025 04:01
@leighmcculloch leighmcculloch marked this pull request as ready for review May 20, 2025 04:02
Example usage:

```ruby
require 'xdrgen'
Copy link
Member Author

Choose a reason for hiding this comment

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

Telling folks to use the gem as published on xdrgen doesn't really work today because this library hasn't been released to rubygems since 2021 and the released version doesn't have features like the custom generator.

I'm working with ops to get this repo setup to be able to publish again:

Copy link
Member Author

Choose a reason for hiding this comment

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

@leighmcculloch leighmcculloch merged commit 9796d62 into master May 20, 2025
5 checks passed
@leighmcculloch leighmcculloch deleted the update-readme branch May 20, 2025 22:20
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.

3 participants