Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 35 lines (19 sloc) 2.309 kB
2eac8cb @gschneider-r7 add more badges to readme, rearrange badges
gschneider-r7 authored
1 # Nexpose-Client
2 [![Gem Version](https://badge.fury.io/rb/nexpose.svg)](http://badge.fury.io/rb/nexpose) [![Build Status](https://travis-ci.org/rapid7/nexpose-client.svg?branch=master)](https://travis-ci.org/rapid7/nexpose-client) [![Test Coverage](https://codeclimate.com/github/rapid7/nexpose-client/badges/coverage.svg)](https://codeclimate.com/github/rapid7/nexpose-client) [![Inline docs](http://inch-ci.org/github/rapid7/nexpose-client.svg?branch=master)](http://inch-ci.org/github/rapid7/nexpose-client) [![Code Climate](https://codeclimate.com/github/rapid7/nexpose-client/badges/gpa.svg)](https://codeclimate.com/github/rapid7/nexpose-client)
bcd5e91 include the gem contents
HD Moore authored
3
a1e752b @gschneider-r7 Update README.markdown
gschneider-r7 authored
4 This is the official gem package for the Ruby Nexpose API client library.
bcd5e91 include the gem contents
HD Moore authored
5
a1e752b @gschneider-r7 Update README.markdown
gschneider-r7 authored
6 For assistance with using the gem, to share your scripts, or to discuss different approaches, please visit the Rapid7 community: https://community.rapid7.com/
20ad9e8 @mdaines-r7 Updates to README
mdaines-r7 authored
7
a1e752b @gschneider-r7 Update README.markdown
gschneider-r7 authored
8 Check out the [wiki](https://github.com/rapid7/nexpose-client/wiki) for walk-throughs and other documentation. Submit bugs and feature requests on the [issues](https://github.com/rapid7/nexpose-client/issues) page.
8cdf58c @mdaines-r7 Additional README changes.
mdaines-r7 authored
9
a1e752b @gschneider-r7 Update README.markdown
gschneider-r7 authored
10 This gem is heavily used for internal, automated testing of the Nexpose product. It provides calls to the Nexpose XML APIs version 1.1 and 1.2, and JSON API 2.1. It also includes a number of helper methods which are not currently exposed through alternate means.
8cdf58c @mdaines-r7 Additional README changes.
mdaines-r7 authored
11
1467526 @gschneider-r7 Bump version to 2.0.0 and update readme
gschneider-r7 authored
12 Since version 1.0 nexpose-client uses [Semantic Versioning](http://semver.org/). This allows for confident use of the [pessimistic operator](https://robots.thoughtbot.com/rubys-pessimistic-operator) in scripts or larger ruby projects.
13
add0472 @gschneider-r7 Add release notes link to readme
gschneider-r7 authored
14 ## Release Notes
15
16 Release notes are available on the [Releases](https://github.com/rapid7/nexpose-client/releases) page.
50811d1 @mdaines-r7 Add message to point to community for questions.
mdaines-r7 authored
17
ccff6d5 @mdaines-r7 Adds convenience methods to Site class.
mdaines-r7 authored
18 ## Contributions
19
5edef56 @mdaines-r7 Adds CONTRIBUTING Link to README
mdaines-r7 authored
20 We welcome contributions to this package. Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
20ad9e8 @mdaines-r7 Updates to README
mdaines-r7 authored
21
22 Our coding standards include:
ccff6d5 @mdaines-r7 Adds convenience methods to Site class.
mdaines-r7 authored
23
24 * Favor returning classes over key-value maps. Classes tend to be easier for users to manipulate and use.
75fa6aa @mdaines-r7 Refactors Site for usability.
mdaines-r7 authored
25 * Unless otherwise noted, code should adhere to the Ruby Style Guide: https://github.com/bbatsov/ruby-style-guide
26 * Use YARDoc comment style to improve the API documentation of the gem.
ccff6d5 @mdaines-r7 Adds convenience methods to Site class.
mdaines-r7 authored
27
a836057 @todb-r7 Name it correctly and mention the license
todb-r7 authored
28 ## License
29
30 The nexpose-client gem is provided under the 3-Clause BSD License. See [COPYING](COPYING) for details.
31
ccff6d5 @mdaines-r7 Adds convenience methods to Site class.
mdaines-r7 authored
32 ## Credits
75fa6aa @mdaines-r7 Refactors Site for usability.
mdaines-r7 authored
33
6f40b45 @todb-r7 Rapid7 is an Inc, no longer an LLC
todb-r7 authored
34 Rapid7, Inc.
Something went wrong with that request. Please try again.