Skip to content

Commit 77964a6

Browse files
committed
Added license and unit test instructions
1 parent 748ba96 commit 77964a6

File tree

3 files changed

+36
-1
lines changed

3 files changed

+36
-1
lines changed

LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2013 Bryan C. Geraghty
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in
13+
all copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
THE SOFTWARE.

README

+14
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,20 @@ generate an encryption key with the following command:
9292

9393
This will produce the value, 'Foobar'.
9494

95+
Unit Tests
96+
==========
97+
In order to run the unit tests included with the library, you must have
98+
PHP 5.4 installed (Sorry, it's a PHPUnit requirement). To install all of
99+
the unit test support libraries, simply change into the library's root and
100+
enter the following command:
101+
102+
./bin/composer.phar install
103+
104+
Once composer has finished doing its thing, issue the folowing command to
105+
run the tests:
106+
107+
./bin/runtests
108+
95109
That's it!
96110
==========
97111
I this is better than what we have now.

Simple.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
* @package PHPCrypt
1010
* @author Bryan C. Geraghty <[email protected]>
1111
* @copyright 2013 Bryan C. Geraghty
12-
* @license http://www.gnu.org/licenses/lgpl-3.0.txt GNU LGPL
12+
* @license https://github.com/archwisp/PHPCrypt/blob/master/LICENSE MIT
1313
* @link https://github.com/archwisp/PHPCrypt
1414
*/
1515

0 commit comments

Comments
 (0)