diff options
author | Arseny Kapoulkine <arseny.kapoulkine@gmail.com> | 2014-02-09 00:28:29 +0000 |
---|---|---|
committer | Arseny Kapoulkine <arseny.kapoulkine@gmail.com> | 2014-02-09 00:28:29 +0000 |
commit | 7b41dce85e8f8788027672845fd2867dd9e2b27a (patch) | |
tree | e3a00942aa2cc6a4af46046fac22ad476a4e2ce8 | |
parent | 09647e2b29660b61fc00bbdede190a36dfb22e68 (diff) |
Add README.md for GitHub
git-svn-id: http://pugixml.googlecode.com/svn/trunk@970 99668b35-9821-0410-8761-19e4c4f06640
-rw-r--r-- | README.md | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..01a53a0 --- /dev/null +++ b/README.md @@ -0,0 +1,44 @@ +pugixml [![Build Status](https://travis-ci.org/zeux/pugixml.png?branch=master)](https://travis-ci.org/zeux/pugixml) +======= + +pugixml is a C++ XML processing library, which consists of a DOM-like interface with rich traversal/modification +capabilities, an extremely fast XML parser which constructs the DOM tree from an XML file/buffer, and an XPath 1.0 +implementation for complex data-driven tree queries. Full Unicode support is also available, with Unicode interface +variants and conversions between different Unicode encodings (which happen automatically during parsing/saving). + +pugixml is used by a lot of projects, both open-source and proprietary, for performance and easy-to-use interface. + +## Documentation + +Documentation for the current release of pugixml is available on-line as two separate documents: + +* [Quick-start guide](http://pugixml.googlecode.com/svn/tags/latest/docs/quickstart.html), that aims to provide enough information to start using the library; +* [Complete reference manual](http://pugixml.googlecode.com/svn/tags/latest/docs/manual.html), that describes all features of the library in detail. + +You’re advised to start with the quick-start guide; however, many important library features are either not described in it at all or only mentioned briefly; if you require more information you should read the complete manual. + +## License +This library is available to anybody free of charge, under the terms of MIT License: + +Copyright (c) 2006-2014 Arseny Kapoulkine + +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.
\ No newline at end of file |