Skip to content

Commit

Permalink
update README and LICENSE files expath#52 (expath#53)
Browse files Browse the repository at this point in the history
- add release badge (displayed when the release is available)
- remove references to maven plugins as XSpec plugins are in the process to be consolidated under the XSpec organisation
- remove reference to jxsl (this project doesn't seem to be active anymore)
- add section Contribute
- update License section and years in copyright
  • Loading branch information
Sandro Cirulli authored Jan 15, 2017
1 parent 441eae6 commit 5aa7644
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 27 deletions.
4 changes: 2 additions & 2 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License

Copyright (c) 2008, 2010 Jeni Tennison
Copyright (c) 2008-2017 Jeni Tennison

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand All @@ -18,4 +18,4 @@ 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.
THE SOFTWARE.
37 changes: 12 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,26 @@
[![Travis Build Status](https://api.travis-ci.org/xspec/xspec.svg?branch=master "Travis Build Status")](https://travis-ci.org/xspec/xspec)
[![AppVeyor Build status](https://ci.appveyor.com/api/projects/status/github/xspec/xspec?branch=master&svg=true "AppVeyor Build Status")](https://ci.appveyor.com/project/xspec/xspec/branch/master)

## XSpec
## XSpec [![Release](https://img.shields.io/github/release/xspec/xspec.svg)](https://github.com/xspec/xspec/releases/latest)

Version 0.4.0.
XSpec is a unit test and [behaviour driven development](http://en.wikipedia.org/wiki/Behavior_Driven_Development) (BDD) framework for XSLT and XQuery. It is based on the Spec framework of [RSpec](http://rspec.info/), which is a BDD framework for Ruby.

XSpec is a [Behaviour Driven Development](http://en.wikipedia.org/wiki/Behavior_Driven_Development)
(BDD) framework for XSLT and XQuery. It is based on the Spec
framework of [RSpec](http://rspec.info/), which is a BDD framework for
Ruby.
XSpec consists of a syntax for describing the behaviour of XSLT or XQuery code and some code that enables to test the code against those descriptions.

XSpec consists of a syntax for describing the behaviour of your XSLT
or XQuery code, and some code that enables you to test your code
against those descriptions.
## Getting Started

Maven plugins for running XSpec tests as part of a build are available from [adamretter](http://github.com/adamretter/xspec-maven-plugin) and [daisy](http://github.com/daisy/xspec-maven-plugin).
To get started, check out the installation instructions for [MacOS/Linux](https://github.com/xspec/xspec/wiki/Installation-on-Mac-and-Linux) and [Windows](https://github.com/xspec/xspec/wiki/Installation-on-Windows) and how to [write your first XSpec test](https://github.com/xspec/xspec/wiki/Getting-Started).

An external project, [jxsl](http://code.google.com/p/jxsl/), provides
a Maven archetype for XSpec (Ant is expected soon). The goal is to
provide everything needed to integrate with Continuous Integration
tools for Java (like Hudson, Cruise Control, etc.) See Benoit's
[presentation at Balisage 2011](http://www.balisage.net/Proceedings/vol7/html/Mercier01/BalisageVol7-Mercier01.html)
in Montreal for more info.
## Support

The project owners are Jeni Tennison and Florent Georges.
Check out the XSpec documentation in the [wiki](https://github.com/xspec/xspec/wiki) before raising an issue or ask a question. If you have any question which is not answered in the wiki, feel free to [raise an issue](https://github.com/xspec/xspec/issues) or post it in the [XSpec discussion list](http://groups.google.com/group/xspec-users).

### Usage:
## Contribute

For more information about using XSpec, visit the project wiki at
<https://github.com/expath/xspec/wiki>. If you have any questions,
you can also join (or search the archives of) the XSpec discussion
list: <http://groups.google.com/group/xspec-users>.
XSpec is an open source project originally written by [Jeni Tennison](https://github.com/JeniT). It was maintained in the past years by [Florent Georges](https://github.com/fgeorges). Active development of XSpec restarted in 2016 and the project is currently maintained by [Sandro Cirulli](https://github.com/cirulls) with the help of the XSpec community.

If you wish to contribute to XSpec, [raise or pick up an issue](https://github.com/xspec/xspec/issues) and [send us your pull requests](https://github.com/xspec/xspec/pulls). Please document any issue with examples of your XSpec code.

### License:
## License

XSpec is released under the MIT license. For a copy of this license,
see [LICENSE](LICENSE), or go to <http://www.opensource.org/licenses/mit-license.php>.
XSpec is released under the [MIT License](LICENSE). [Few parts of the codebase](https://github.com/xspec/xspec/blob/master/java/com/jenitennison/xslt/tests/XSLTCoverageTraceListener.java) are released under the [Mozilla Public License](http://www.mozilla.org/MPL/).

0 comments on commit 5aa7644

Please sign in to comment.