Improvements to readme #5

Merged
bookercodes merged 8 commits from master into master 2015-07-26 11:15:59 +00:00
bookercodes commented 2015-07-22 22:32:15 +00:00 (Migrated from github.com)

Changes

  • Took the text from this issue and put it in the readme.md. It is much more prominent now.
  • I made the contributing guidelines in readme.md a little bit clearer with a header, bullet points and an additional example link.
  • I made the warning about not submitting ideas here on GitHub friendlier so that people feel more welcome to join the discussion on Reddit.
  • Added a contributing.md file. Now, when users submit an issue, they will see an alert like this:

The link will take them to contributing.md. (If you want, you can disable issues, by the way.)

  • Corrected the capitalization in the tagline, in readme.md. You may want to do this for the repository description, also.
  • Added "support us" section to readme.md.
  • Used logo in place of header. It adds some brand identity to the repository and looks good, too.

You can see the outcome on my fork, here.

Note

I apologize for not asking permission to submit a pull request first. I hope you like the changes that I made but if not, I will understand if you would rather not merge them.

I intentionally made a lot of small commits so that you can cherry pick the ones that you want (if any).

Thanks.

**Changes** - Took the text from [this issue](https://github.com/privacytoolsIO/privacytools.io/issues/1) and put it in the readme.md. It is much more prominent now. - I made the contributing guidelines in readme.md a little bit clearer with a header, bullet points and an additional example link. - I made the warning about not submitting ideas here on GitHub friendlier so that people feel more welcome to join the discussion on Reddit. - Added a contributing.md file. Now, when users submit an issue, they will see an alert like this: ![](http://i.imgur.com/geR0Me0.png) The link will take them to contributing.md. (If you want, you can [disable issues](https://help.github.com/articles/disabling-issues/), by the way.) - Corrected the capitalization in the tagline, in readme.md. You may want to do this for the repository description, also. - Added "support us" section to readme.md. - Used logo in place of header. It adds some brand identity to the repository and looks good, too. You can see the outcome on my fork, [here](https://github.com/alexbooker/privacytools.io). **Note** I apologize for not asking permission to submit a pull request first. I _hope_ you like the changes that I made but if not, I will understand if you would rather not merge them. I intentionally made a lot of small commits so that you can [cherry pick](http://git-scm.com/docs/git-cherry-pick) the ones that you want (if any). Thanks.
bookercodes commented 2015-07-25 08:20:24 +00:00 (Migrated from github.com)

Anything else I can do for this PR?

Anything else I can do for this PR?
privacytoolsIO commented 2015-07-26 11:18:02 +00:00 (Migrated from github.com)

Thank you so much, alexbooker. Good work. I could use some help maintaining this project on github. Would you be interested?

Thank you so much, alexbooker. Good work. I could use some help maintaining this project on github. Would you be interested?
bookercodes commented 2015-07-26 12:13:49 +00:00 (Migrated from github.com)

Yes, I would -- I love the website 😄

Yes, I would -- I love the website :smile:
privacytoolsIO commented 2015-07-26 19:30:15 +00:00 (Migrated from github.com)

I've just added you as a collaborator. Will that enhance your rights in this repository?

I've just added you as a collaborator. Will that enhance your rights in this repository?
bookercodes commented 2015-07-26 20:21:36 +00:00 (Migrated from github.com)

Yep. Thank you.

I was also subscribed to notifications relating to this repo.

If someone sends a pull request or an issue, I will be sure to weigh in 😄.

Am I speaking to u/BurungHantu, by the way?

Yep. Thank you. I was also subscribed to notifications relating to this repo. If someone sends a pull request or an issue, I will be sure to weigh in :smile:. Am I speaking to [u/BurungHantu](https://www.reddit.com/user/BurungHantu), by the way?
privacytoolsIO commented 2015-07-27 10:34:38 +00:00 (Migrated from github.com)

Yes, that's me. Are you also on reddit?

Yes, that's me. Are you also on reddit?
bookercodes commented 2015-07-27 10:43:16 +00:00 (Migrated from github.com)

Yep. I'm u/bookerio.

Yep. I'm [u/bookerio](https://www.reddit.com/user/bookerio/).
This repo is archived. You cannot comment on pull requests.
No reviewers
No Milestone
No Assignees
1 Participants
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: privacyguides/privacytools.io#5
No description provided.