Skip to content
This repository was archived by the owner on Apr 7, 2021. It is now read-only.

Commit 5138d2f

Browse files
committed
updating docs
1 parent a9273a4 commit 5138d2f

26 files changed

+50
-26
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,20 @@ There is [documentation for `laravel-security-txt` online](https://austinheap.gi
3434
the source of which is in the [`docs/`](https://github.com/austinheap/laravel-security-txt/tree/master/docs)
3535
directory. The most logical place to start are the [docs for the `SecurityTxt` class](https://austinheap.github.io/laravel-security-txt/classes/AustinHeap.Security.Txt.SecurityTxt.html).
3636

37+
## Table of Contents
38+
39+
* [Summary](#a-package-for-serving-securitytxt-in-laravel-55-based-on-configuration-settings)
40+
* [Installation](#installation)
41+
+ [Step 1: Composer](#step-1-composer)
42+
+ [Step 2: Remove any existing `security.txt`](#step-2-remove-any-existing-securitytxt)
43+
+ [Step 3: Enable the package (Optional)](#step-3-enable-the-package-optional)
44+
+ [Step 4: Configure the package](#step-4-configure-the-package)
45+
* [Full `.env` Example](#full-env-example)
46+
* [Unit Tests](#unit-tests)
47+
* [References](#references)
48+
* [Credits](#credits)
49+
* [License](#license)
50+
3751
## Installation
3852

3953
### Step 1: Composer
@@ -145,6 +159,14 @@ Acknowledgement: http://some.url/acks
145159
#
146160
```
147161

162+
## Unit Tests
163+
164+
This package has aggressive unit tests built with the wonderful [orchestral/testbench](https://github.com/orchestral/testbench)
165+
package which is built on top of PHPUnit.
166+
167+
There are [code coverage reports for `laravel-security-txt`](https://austinheap.github.io/laravel-security-txt/coverage/)
168+
available online.
169+
148170
## References
149171

150172
- [A Method for Web Security Policies (draft-foudil-securitytxt-00)](https://tools.ietf.org/html/draft-foudil-securitytxt-00)

composer.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
}
1919
],
2020
"require": {
21+
"php": ">=7.0.0",
2122
"laravel/framework": "5.5.*",
2223
"austinheap/php-security-txt": "^0.4"
2324
},

docs/_config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
include: [".css", ".fonts", ".js"]

docs/classes/AustinHeap.Security.Txt.SecurityTxtController.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -282,7 +282,7 @@ <h3>Response</h3>
282282
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by
283283
<a href="http://glyphicons.com/">Glyphicons</a>.<br/>
284284
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and<br/>
285-
generated on Wed, 22 Nov 2017 22:33:07 +0000.<br/>
285+
generated on Thu, 14 Dec 2017 06:50:00 +0000.<br/>
286286
</footer>
287287
</body>
288288
</html>

docs/classes/AustinHeap.Security.Txt.SecurityTxtFacade.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -292,7 +292,7 @@ <h3>Response</h3>
292292
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by
293293
<a href="http://glyphicons.com/">Glyphicons</a>.<br/>
294294
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and<br/>
295-
generated on Wed, 22 Nov 2017 22:33:07 +0000.<br/>
295+
generated on Thu, 14 Dec 2017 06:50:00 +0000.<br/>
296296
</footer>
297297
</body>
298298
</html>

docs/classes/AustinHeap.Security.Txt.SecurityTxtHelper.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1191,7 +1191,7 @@ <h3>Type(s)</h3>
11911191
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by
11921192
<a href="http://glyphicons.com/">Glyphicons</a>.<br/>
11931193
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and<br/>
1194-
generated on Wed, 22 Nov 2017 22:33:07 +0000.<br/>
1194+
generated on Thu, 14 Dec 2017 06:50:00 +0000.<br/>
11951195
</footer>
11961196
</body>
11971197
</html>

docs/classes/AustinHeap.Security.Txt.SecurityTxtServiceProvider.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -340,7 +340,7 @@ <h3>Type(s)</h3>
340340
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by
341341
<a href="http://glyphicons.com/">Glyphicons</a>.<br/>
342342
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and<br/>
343-
generated on Wed, 22 Nov 2017 22:33:07 +0000.<br/>
343+
generated on Thu, 14 Dec 2017 06:50:00 +0000.<br/>
344344
</footer>
345345
</body>
346346
</html>

docs/coverage/SecurityTxtController.php.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -211,7 +211,7 @@ <h4>Legend</h4>
211211
<span class="warning"><strong>Dead Code</strong></span>
212212
</p>
213213
<p>
214-
<small>Generated by <a href="https://github.com/sebastianbergmann/php-code-coverage" target="_top">php-code-coverage 5.2.3</a> using <a href="https://secure.php.net/" target="_top">PHP 7.1.11</a> with <a href="https://xdebug.org/">Xdebug 2.5.5</a> and <a href="https://phpunit.de/">PHPUnit 6.4.4</a> at Wed Nov 22 22:31:12 UTC 2017.</small>
214+
<small>Generated by <a href="https://github.com/sebastianbergmann/php-code-coverage" target="_top">php-code-coverage 5.2.3</a> using <a href="https://secure.php.net/" target="_top">PHP 7.1.11</a> with <a href="https://xdebug.org/">Xdebug 2.5.5</a> and <a href="https://phpunit.de/">PHPUnit 6.4.4</a> at Thu Dec 14 6:48:14 UTC 2017.</small>
215215
</p>
216216
<a title="Back to the top" id="toplink" href="#"><span class="glyphicon glyphicon-arrow-up"></span></a>
217217
</footer>

docs/coverage/SecurityTxtFacade.php.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,7 @@ <h4>Legend</h4>
209209
<span class="warning"><strong>Dead Code</strong></span>
210210
</p>
211211
<p>
212-
<small>Generated by <a href="https://github.com/sebastianbergmann/php-code-coverage" target="_top">php-code-coverage 5.2.3</a> using <a href="https://secure.php.net/" target="_top">PHP 7.1.11</a> with <a href="https://xdebug.org/">Xdebug 2.5.5</a> and <a href="https://phpunit.de/">PHPUnit 6.4.4</a> at Wed Nov 22 22:31:12 UTC 2017.</small>
212+
<small>Generated by <a href="https://github.com/sebastianbergmann/php-code-coverage" target="_top">php-code-coverage 5.2.3</a> using <a href="https://secure.php.net/" target="_top">PHP 7.1.11</a> with <a href="https://xdebug.org/">Xdebug 2.5.5</a> and <a href="https://phpunit.de/">PHPUnit 6.4.4</a> at Thu Dec 14 6:48:14 UTC 2017.</small>
213213
</p>
214214
<a title="Back to the top" id="toplink" href="#"><span class="glyphicon glyphicon-arrow-up"></span></a>
215215
</footer>

0 commit comments

Comments
 (0)