Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Added license and clarification in the README.

  • Loading branch information...
commit e45713a801265d809cb96ce64ecac70eb1a06f38 1 parent d307296
@bobsomers bobsomers authored
Showing with 37 additions and 1 deletion.
  1. +22 −0 LICENSE
  2. +15 −1 README.md
View
22 LICENSE
@@ -0,0 +1,22 @@
+MemLog is released as open source software under the zlib license.
+
+Copyright (c) 2012 iFixit
+
+This software is provided 'as-is', without any express or implied
+warranty. In no event will the authors be held liable for any damages
+arising from the use of this software.
+
+Permission is granted to anyone to use this software for any purpose,
+including commercial applications, and to alter it and redistribute it
+freely, subject to the following restrictions:
+
+ 1. The origin of this software must not be misrepresented; you must not
+ claim that you wrote the original software. If you use this software
+ in a product, an acknowledgment in the product documentation would be
+ appreciated but is not required.
+
+ 2. Altered source versions must be plainly marked as such, and must not be
+ misrepresented as being the original software.
+
+ 3. This notice may not be removed or altered from any source
+ distribution.
View
16 README.md
@@ -15,6 +15,8 @@ the following fields:
class name of the currently executing code, if any (string),
function name of the currently executing code, if any (string)]
+## Usage
+
Basic usage is as follows:
$memlog = new MemLog();
@@ -26,10 +28,22 @@ Basic usage is as follows:
Log files are saved with a base path of `MemLog::$basePath`, Unless you have
a compelling reason, `/tmp` is a good choice for `$basePath`.
+
+## Log Viewer
Also included is a very basic MemLog viewer. You **should not** host the
viewer on a production server, as it has some security concerns because it's
a quick and dirty example of how you can show MemLog files in a meaningful
way.
-Patches/contributions are welcome.
+## Patches
+
+Patches and contributions are welcome. You can contact the author at
+`bob AT ifixit DOT com`.
+
+## License
+
+MemLog is released as open source software under the zlib license. In a
+nutshell, this means you are free to use, modify, and redistribute it,
+regardless of whether your project is open source or proprietary. See the text
+of the zlib license in LICESE for more information.
Please sign in to comment.
Something went wrong with that request. Please try again.