diff --git a/README.markdown b/README.markdown index de5d6e0..a886114 100644 --- a/README.markdown +++ b/README.markdown @@ -1 +1,38 @@ +# Introduction + A plugin for node.js which parses HTTP referrers for search engine names and search keywords. + +# Usage + + sp = require('searchparser'); + + var sinfo = sp.parse('http://www.bing.com/search?q=node.js+tutorial&go=&form=QBLH&qs=n&sk='); + var search_engine = sinfo['search_engine']; + var search_keywords = sinfo['search_keywords']; + +# Installation + +Using npm run `npm install searchparser` + +You can get npm from http://npmjs.org/ + +# License + +Copyright 2010 Dan Grossman. All rights reserved. +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.