From 80d7b15cb204ee1804a0346ac1433f2fb937fb13 Mon Sep 17 00:00:00 2001 From: Calamari Date: Wed, 5 Feb 2014 13:47:43 +0100 Subject: [PATCH] Readme explains usage, contribution and license --- README.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..85ce464 --- /dev/null +++ b/README.md @@ -0,0 +1,43 @@ +# StackTrace-Parser + +This parser parses a stack trace from any browser and returns an array of hashes representing a line. + +## Usage + +``` JavaScript +try { + throw new Error('My error'); +} catch(ex) { + var lines = StackTraceParser.parse(ex.stack); +} +``` + +Every line contains four properties: `lineNumber`, `methodName`, `file` and `column` (if applicable). + +## Contribution + +If you want to contrib, then do you thing, write tests, run `grunt test` ensure that everything is green , commit and make the pull request. Or just write an issue, or let's talk. + +## LICENSE + +The MIT License (MIT) + +Copyright (c) 2014 Georg Tavonius + +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.