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

Cleanup README #18

Merged
merged 1 commit into from Oct 29, 2019
Merged

Cleanup README #18

merged 1 commit into from Oct 29, 2019

Conversation

@westonganger
Copy link

westonganger commented Oct 28, 2019

This PR cleans up the readme

@noniq

This comment has been minimized.

Copy link

noniq commented Oct 28, 2019

Hm, do we really want to have the detailled information about related gems (and also some other stuff) removed from the first section? What’s your rationale for this change?

@westonganger

This comment has been minimized.

Copy link
Author

westonganger commented Oct 28, 2019

For the information regarding additional gems, I did not like how it was the first thing in the readme instead of explaining this gem first. We could add another section for Plugins / Integrations with fresh information regarding these.

The details section always bothered me, highlighting outdated things like

  • Release Date from 2013
  • IRC (outdated)
  • Google groups (outdated, we should just use github/stackoverflow instead)
  • Copyright years that are not kept current
  • Pointing at JRuby and Rubinius can be confusing (we dont even test against these)
@noniq

This comment has been minimized.

Copy link

noniq commented Oct 29, 2019

Makes sense. Let’s add a section with information about the other gems, and remove the outdated details. We should also add a link to docs/style_reference.md (and to docs/header_and_footer_codes.md if there is none yet).

@westonganger westonganger force-pushed the westonganger:improve_readme branch from 172ebf7 to 0f0a1a1 Oct 29, 2019
@westonganger westonganger force-pushed the westonganger:improve_readme branch from abaa4b6 to 2985c18 Oct 29, 2019
@westonganger

This comment has been minimized.

Copy link
Author

westonganger commented Oct 29, 2019

Alright this should be complete now

@noniq noniq merged commit 2d77319 into caxlsx:master Oct 29, 2019
1 check passed
1 check passed
Travis CI - Pull Request Build Passed
Details
@noniq

This comment has been minimized.

Copy link

noniq commented Oct 29, 2019

Merged, thanks a lot!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.