Skip to content

Commit 33d4e9b

Browse files
committed
License, readme and version docs.
1 parent a9dedba commit 33d4e9b

File tree

3 files changed

+55
-0
lines changed

3 files changed

+55
-0
lines changed

LICENSE

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
2+
progstr.log
3+
http://progstr.com
4+
(c) 2011 Progstr.com
5+
6+
The MIT License
7+
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:
8+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
9+
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.

README.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
2+
Progstr.Log is a service that collects and manages programmer log entries in the cloud. Most web applications log errors and special external events generated by users or third party systems. Progstr.Log takes away the pain of complex logging system configurations, provides a centralized location for all your log entries and helps you analyze the data you've collected over time. *progstr-js* is the JavaScript client library that collects log entries and transports them to Progstr data store.
3+
4+
#Installation
5+
6+
* Sign up for Progstr.Log and obtain an API token. That token is used to identify you against the service.
7+
* Include the `progstr.js` script on your page by refering it from the `ajax.progstr.com` server:
8+
<pre>
9+
&lt;script type="text/javascript" src="http://ajax.progstr.com/progstr-js/1.0.0/progstr.js"&gt;&lt;/script&gt;
10+
</pre>
11+
* Configure the API token by setting the `Progstr.apiToken` property in a script block:
12+
<pre>
13+
&lt;script type="text/javascript"&gt;
14+
Progstr.apiToken = "6f413b64-a8e1-4e25-b9e6-d83acf26ccba"
15+
&lt;/script&gt;
16+
</pre>
17+
18+
#Getting started
19+
20+
There are four log severity levels that you can use to log events of different importance:
21+
22+
* Info: used to log general information events that can be used for reference or troubleshooting if needed.
23+
* Warning: something odd happened and somebody needs to know about it.
24+
* Error: something failed and needs to be fixed.
25+
* Fatal: the entire application or a critical part of it is not working at all.
26+
27+
To log an event you need to obtain a logger object and call some of its `info`/`warning`/`error`/`fatal` methods.
28+
29+
var logger = Progstr.logger("js.demo.source")
30+
...
31+
logger.info("Loading page: " + window.location.href)
32+
...
33+
logger.warning("User not found.")
34+
...
35+
logger.error("Operation failed.")
36+
...
37+
logger.fatal("Could not connect to server.")
38+
39+
# Supported browsers
40+
41+
* All major browsers out there.
42+
43+
# Documentation
44+
45+
Available online [here](http://docs.progstr.com).

VERSION

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
1.0.0

0 commit comments

Comments
 (0)