From 1c29941ec6f60f0163a30a48e0ccb94b87bc84d3 Mon Sep 17 00:00:00 2001 From: Aaron Parecki Date: Sun, 30 Apr 2017 09:13:53 -0700 Subject: [PATCH] add readme/license/contributing --- CONTRIBUTING.md | 1 + LICENSE | 21 +++++++++++++++++++++ README.md | 16 ++++++++++++++++ 3 files changed, 38 insertions(+) create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE create mode 100644 README.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..2d26f21 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1 @@ +By contributing to this project, you agree to irrevocably release your contributions under the same license as this project. See README.md for more details. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..42310e7 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2017 Aaron Parecki + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..2193a22 --- /dev/null +++ b/README.md @@ -0,0 +1,16 @@ +p3k\utils +========= + +This project provides several helpful utilities for working with PHP projects, and is used by https://p3k.io applications. + +* `p3k\date` - helpful functions for working with dates and timezones +* `p3k\url` - helpful functions for parsing and building URLs +* `p3k\cache` - a simple caching helper backed by Redis +* `p3k\utils` - miscellaneous functions +* `p3k\global` - sets the timezone to UTC (you're already storing all your dates in UTC, right?) + +PHP Support +----------- + +This project should work in all versions of PHP 5.5 and newer. +