Skip to content

Conversation

@BurdetteLamar
Copy link
Member

Updates:

  • Usage: now points to the main class.
  • Installation: deleted (no longer needed).

@BurdetteLamar BurdetteLamar added the documentation Improvements or additions to documentation label Jan 31, 2023
Copy link
Member

@peterzhu2118 peterzhu2118 left a comment

Choose a reason for hiding this comment

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

While I'm all for refactoring/rewriting the README, I'm not a fan of deleting a large chunk of it. The README is the first document a user sees when they navigate to this repo, so it should describe what this library is, how to install it, and a quick start guide that highlights the most common ways to use this library (and perhaps linking to separate documentation for more advanced things).

@BurdetteLamar
Copy link
Member Author

While I'm all for refactoring/rewriting the README, I'm not a fan of deleting a large chunk of it. The README is the first document a user sees when they navigate to this repo, so it should describe what this library is, how to install it, and a quick start guide that highlights the most common ways to use this library (and perhaps linking to separate documentation for more advanced things).

I'll be happy to restore the Usage section. The Installation section should remain deleted? Along with the remark about installation in the Development section?

@peterzhu2118
Copy link
Member

I think the Installation and Usage sections should be kept (or rewritten). I also think the blurb at the beginning should be expanded, IMO the one-liner is a bit too simple. The other parts I'm ok with deleting.

@BurdetteLamar
Copy link
Member Author

I think the Installation and Usage sections should be kept (or rewritten). I also think the blurb at the beginning should be expanded, IMO the one-liner is a bit too simple. The other parts I'm ok with deleting.

Re Installation: Doesn't Net::HTTP come with Ruby nowadays? So no installation needed?

@peterzhu2118
Copy link
Member

peterzhu2118 commented Feb 1, 2023

Yes, it's bundled with Ruby, but it might not be the latest version, in which case they'll have to install it from RubyGems. We can mention this in the README.

@BurdetteLamar
Copy link
Member Author

Stet, then.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants