Docs improvement #29
Merged
Docs improvement #29
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Closed
| @@ -1,7 +1,9 @@ | |||
| Laravel Binput | |||
| ============== | |||
|
|
|||
| Laravel Binput was created by, and is maintained by [Graham Campbell](https://github.com/GrahamCampbell), and is an input protector for [Laravel 5](http://laravel.com). It utilises my [Laravel Security](https://github.com/GrahamCampbell/Laravel-Security) package. Feel free to check out the [change log](CHANGELOG.md), [releases](https://github.com/GrahamCampbell/Laravel-Binput/releases), [license](LICENSE), and [contribution guidelines](CONTRIBUTING.md). | |||
| Laravel Binput was created by, and is maintained by [Graham Campbell](https://github.com/GrahamCampbell), and is an input protector for [Laravel 5](http://laravel.com) that strips unwanted elements, e.g. `<script>` tags from any input you receive. It utilises my [Laravel Security](https://github.com/GrahamCampbell/Laravel-Security) package. | |||
There was a problem hiding this comment.
Hmm, this description isn't quite true.
There was a problem hiding this comment.
I might have misunderstood something. 😉 Please let me know what I should change.
There was a problem hiding this comment.
It prevents them doing damage rather than removing all traces of them.
|
Will change it once I am back at my notebook. |
I think this could make it easier to understand. I would also add an example to clarify what the `xss` boolean does, as well as showing the default values from the config. If you are fine with this I can create an additional PR with those changes. I think that users who are not comfortable with tests, etc. will not look into those, and you do not want to digg through tests just to figure out what a package does. Worts scenario, people just don't use the package, which would be sad, as it is a really good one.
|
Hey @GrahamCampbell, I updated the text, do you think this now reflects the reality better? |
|
Hey @GrahamCampbell what do you think, can this be merged, or would you need something change first? |
|
Thanks. I'll tweak it myself now. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I think this could make it easier to understand. I would also add an example to clarify what the
xssboolean does, as well as showing the default values from the config.If you are fine with this I can create an additional PR with those changes.
I think that users who are not comfortable with tests, etc. will not look into those, and you do not want to digg through tests just to figure out what a package does.
Worst scenario, people just don't use the package, which would be sad, as it is a really good one.
This would fix #28