Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 43 lines (26 sloc) 1.523 kB
c0d9448 @gilbitron Updated readme.
authored
1 #PUF
2
3 Website: [http://puf.dev7studios.com](http://puf.dev7studios.com/)
f3f5bd9 @gilbitron Initial commit.
authored
4
5 PUF (PHP Utility Framework) provides PHP developers with an assortment of utility functions that are commonly used in web applications.
6 Written in PHP 5, PUF aims to become the "go to" framework for all of those functions that you commonly use in apps but can never find
7 because you've forgotten to add it to your snippet collection.
8
9 ##Requirements
10
11 To use PUF you will need the following:
12
13 * PHP 5.3 or greater
14
15 Yes that's all!
16
f918594 @gilbitron Updated license details to GPL v2.
authored
17 ##Please Contribute
f3f5bd9 @gilbitron Initial commit.
authored
18
19 The only way this project will become successful and useful is if all of you PHP developers contribute to PUF. Got any favorite snippets
20 that aren't in PUF already? Then throw them in and include your name and website in the @author tag in the documentation. The more you contribute
21 to PUF the more everyone will benefit.
22
f918594 @gilbitron Updated license details to GPL v2.
authored
23 So don't be afraid to give PUF a fork and contribute your own functions!
24
25 ##Licensing
26 PUF is released under the [GPL v2](http://www.gnu.org/licenses/gpl-2.0.html).
27
28 Some of the functions that will appear in PUF will be written by other developers or found in other applications (e.g. WordPress, CodeIgniter etc).
29 This is cool. Just make sure the license that their code is released under is compatible with GPL v2, and make sure to give credit where credit is due
1f1997b @gilbitron Added example usage to readme.
authored
30 in the function documentation.
31
32 ##Example Usage
33
34 <?php
35
36 require_once 'puf/puf.include_all.php';
37
38 $puf_format = new PUF\Format();
39
40 echo $puf_format->size_format(1024);
41 // Output: 1kB
42
43 ?>
Something went wrong with that request. Please try again.