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

Restructures readme #9

Merged
merged 1 commit into from Mar 10, 2016
Merged

Restructures readme #9

merged 1 commit into from Mar 10, 2016

Conversation

bravo-kernel
Copy link
Contributor

I rewrote the readme following my notes when I implemented, this should now be (at least) the logical order to help users on their way. Consider this a concept, feedback welcome.

@@ -5,61 +5,103 @@
[![Total Downloads](https://img.shields.io/packagist/dt/muffin/obfuscate.svg?style=flat-square)](https://packagist.org/packages/muffin/obfuscate)
[![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](LICENSE)

CakePHP 3 support for ID obfuscation using any combination of HashIds, Optimus and/or Tiny.
Primary key obfuscation for CakePHP 3 using any combination of
Copy link
Member

Choose a reason for hiding this comment

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

I am not too sure about using the word "combination". Most people would only use either one of them.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

As far as this heading text is concerned I could change it to something more readable like "using X, Y and/or custom strategies".

In general, it's exactly the fact that you can mix and match as needed that makes this plugin awesome and.. is actually how I use it. Optimus for user-ids, Tiny for "linkable" resources.

Sent from my Mobile Device

Op 10 mrt. 2016 om 12:31 heeft ADmad notifications@github.com het volgende geschreven:

In README.md:

@@ -5,61 +5,103 @@
Total Downloads
License

-CakePHP 3 support for ID obfuscation using any combination of HashIds, Optimus and/or Tiny.
+Primary key obfuscation for CakePHP 3 using any combination of
I am not too sure about using the word "combination". Most people would only use either one of them.


Reply to this email directly or view it on GitHub.

Copy link
Member

Choose a reason for hiding this comment

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

Yeah i would prefer a statement with "and/or" or "one or more".

@jadb
Copy link
Member

jadb commented Mar 10, 2016

Nice work @bravo-kernel ! Apart from @ADmad's comment, LGTM.

Smarter intro
@bravo-kernel
Copy link
Contributor Author

Thanks guys, I rebased the smarter intro.

@bravo-kernel
Copy link
Contributor Author

I have a PR for awesome-cakephp ready to once this is merged.

ADmad added a commit that referenced this pull request Mar 10, 2016
@ADmad ADmad merged commit 9e131f2 into UseMuffin:master Mar 10, 2016
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

3 participants