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

Made the README look nicer #906

Merged
merged 13 commits into from
Apr 24, 2019
Merged

Made the README look nicer #906

merged 13 commits into from
Apr 24, 2019

Conversation

sdushantha
Copy link
Contributor

Description

  • Centered the logo and badges
  • Added table of content
  • Added back to top link

Status

READY

Type of change

  • Documentation (fix or adds documentation)

How Has This Been Tested?

I opened the README file and looked at the pretty documentation :)

Checklist:

  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation (if applicable)
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

@codecov
Copy link

codecov bot commented Apr 21, 2019

Codecov Report

Merging #906 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@          Coverage Diff          @@
##           master   #906   +/-   ##
=====================================
  Coverage     100%   100%           
=====================================
  Files          34     34           
  Lines        2197   2197           
=====================================
  Hits         2197   2197

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a927933...f012367. Read the comment docs.

Copy link
Member

@jacobtomlinson jacobtomlinson left a comment

Choose a reason for hiding this comment

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

Thanks for doing this, definitely improves the README. I've requested a few changes. Could you please take a look?

README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Member

@jacobtomlinson jacobtomlinson left a comment

Choose a reason for hiding this comment

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

Thanks for making the changes. I'm afraid I meant remove all of the "Back to top" links.

@sdushantha
Copy link
Contributor Author

@jacobtomlinson Oops.... looks like I missed that one. But I fixed it now :)

Copy link
Member

@jacobtomlinson jacobtomlinson left a comment

Choose a reason for hiding this comment

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

One final comment, sorry to be a pain!

README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@sdushantha
Copy link
Contributor Author

@jacobtomlinson Ready to merge? 😄

@jacobtomlinson jacobtomlinson merged commit d06c016 into opsdroid:master Apr 24, 2019
@jacobtomlinson
Copy link
Member

Ping me your address via DM on Twitter or Gitter and I'll post you some opsdroid stickers!

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.

None yet

2 participants