Skip to content

Readme updates #105

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 19 commits into from
Sep 17, 2020
10 changes: 5 additions & 5 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Splunk SDK for JavaScript Changelog
# Splunk Enterprise SDK for JavaScript Changelog

## v1.9.0

Expand Down Expand Up @@ -173,15 +173,15 @@ across all versions of Splunk.

### New features and APIs

* The Splunk SDK for JavaScript now supports Node.js v0.8.x and v0.10.x
* The Splunk Enterprise SDK for JavaScript now supports Node.js v0.8.x and v0.10.x

* Add back general JQuery HTTP implementation.

* General improvements to unit tests.

### Breaking changes

* The Splunk SDK for JavaScript no longer supports Node.js v0.6.x
* The Splunk Enterprise SDK for JavaScript no longer supports Node.js v0.6.x

* Updated the Node.js request module dependency to v2.21.1

Expand Down Expand Up @@ -250,11 +250,11 @@ across all versions of Splunk.
`splunkjs.JobManager.{events|results|preview}Iterator` methods.

* A new "hello-world"-style code example, `log.js`, has been added to show how
to do simple application logging using the Splunk SDK for JavaScript.
to do simple application logging using the Splunk Enterprise SDK for JavaScript.

### Breaking changes

* The easyXDM library is no longer included with the Splunk SDK for JavaScript
* The easyXDM library is no longer included with the Splunk Enterprise SDK for JavaScript
because this library was not being used, and could not work with a Splunk
instance that had a self-signed SSL certificate.

Expand Down
36 changes: 14 additions & 22 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,42 +2,34 @@

## How to contribute

If you would like to contribute to this project, see [Contributions to Splunk][indivcontrib] for more information.
If you would like to contribute to this project, see [Contributions to Splunk](https://www.splunk.com/en_us/form/contributions.html) for more information.

## Issues & Bug Reports
## Issues and bug reports

If you're seeing some unexpected behavior with this project, please create an [issue on GitHub][issues] with the following information:
If you're seeing some unexpected behavior with this project, please create an [issue](https://github.com/splunk/splunk-sdk-javascript/issues) on GitHub with the following information:

1. Version of this project you're using (ex: 1.7.1)
1. Platform version (ex: Windows Server 2012)
1. Framework version (ex: Node.js 0.10.37) or Browser (ex: Chrome 43.0.2357.81)
1. Splunk version (ex: 6.2.2)
1. Other relevant information (ex: local/remote environment, Splunk network configuration)
2. Platform version (ex: Windows Server 2012)
3. Framework version (ex: Node.js v.0.12) or Browser (ex: Chrome 43.0.2357.81)
4. Splunk Enterprise version (ex: 7.0)
5. Other relevant information (ex: local/remote environment, Splunk network configuration, standalone or distributed deployment, are load balancers used)

Alternatively, if you have a Splunk question please ask on [Splunk Answers][answers]
Alternatively, if you have a Splunk question please ask on [Splunk Answers](https://community.splunk.com/t5/Splunk-Development/ct-p/developer-tools).

## Pull requests

We love to see pull requests!

To create a pull request:

1. Fill out the [Individual Contributor Agreement][indivcontrib].
1. Fork [the repository][repo].
1. Make changes to the **`develop`** branch, preferably with tests.
1. Create a [pull request][pulls] against the **`develop`** branch.
1. Fill out the [Individual Contributor Agreement](https://www.splunk.com/en_us/form/contributions.html).
2. Fork the [repository](https://github.com/splunk/splunk-sdk-javascript).
3. Make changes to the **develop** branch, preferably with tests.
4. Create a [pull request](https://github.com/splunk/splunk-sdk-javascript/pulls) against the **develop** branch.

## Contact us

You can [contact support][contact] if you have Splunk related questions.
If you have a paid Splunk Enterprise or Splunk Cloud license, you can contact [Support](https://www.splunk.com/en_us/support-and-services.html) with questions.

You can reach the Developer Platform team at _devinfo@splunk.com_.
You can reach the Splunk Developer Platform team at _devinfo@splunk.com_.

[contributions]: http://dev.splunk.com/view/opensource/SP-CAAAEDM
[indivcontrib]: http://dev.splunk.com/goto/individualcontributions
[companycontrib]: http://dev.splunk.com/view/companycontributions/SP-CAAAEDR
[answers]: http://answers.splunk.com/
[repo]: https://github.com/splunk/splunk-sdk-javascript
[issues]: https://github.com/splunk/splunk-sdk-javascript/issues
[pulls]: https://github.com/splunk/splunk-sdk-javascript/pulls
[contact]: https://www.splunk.com/en_us/support-and-services.html
16 changes: 16 additions & 0 deletions CREDITS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Third-party software credits

Some of the components included in the Splunk Enterprise SDK for JavaScript are licensed under free or open source licenses. We wish to thank the contributors to those projects.

| Contributor | Description | License |
|:----------- |:----------- |:------- |
| [dox](https://github.com/visionmedia/dox) | RESTful degradable JavaScript routing | [MIT](https://github.com/splunk/splunk-sdk-javascript/blob/master/licenses/LICENSE-DOX) |
| [davis.js](https://github.com/olivernn/davis.js) | Documentation generator | [MIT](https://github.com/splunk/splunk-sdk-javascript/blob/master/licenses/LICENSE-DAVIS) |
| [jquery.class.js](http://ejohn.org/blog/simple-javascript-inheritance/) | Custom class creator | [MIT](https://github.com/splunk/splunk-sdk-javascript/blob/master/licenses/LICENSE-JQUERYCLASS) |
| [nodeunit](https://github.com/caolan/nodeunit/) | Unit testing in node.js and the browser | [MIT](https://github.com/splunk/splunk-sdk-javascript/blob/master/licenses/LICENSE-NODEUNIT) |
| [showdown.js](https://github.com/coreyti/showdown/) | Markdown to HTML converter | [BSD](https://github.com/splunk/splunk-sdk-javascript/blob/master/licenses/LICENSE-SHOWDOWN) |
| [staticresource](https://github.com/atsuya/static-resource/) | Static resource handling | [MIT](https://github.com/splunk/splunk-sdk-javascript/blob/master/licenses/LICENSE-STATICRESOURCE) |
| [webapp2](http://code.google.com/p/webapp-improved/) | A framework for Google App Engine | [Apache](https://github.com/splunk/splunk-sdk-javascript/blob/master/licenses/LICENSE-WEBAPP2) |
| [commander](https://github.com/visionmedia/commander.js/) | Node.js command-line interfaces | [MIT](https://github.com/splunk/splunk-sdk-javascript/blob/master/licenses/LICENSE-COMMANDER) |
| [script.js](https://github.com/ded/script.js/) | Asyncronous JavaScript loader and dependency manager | [Apache](https://github.com/splunk/splunk-sdk-javascript/blob/master/licenses/LICENSE-SCRIPTJS) |
| [base64.js](http://code.google.com/p/javascriptbase64/) | Fast base64 encoding/decoding | [MIT](https://github.com/splunk/splunk-sdk-javascript/blob/master/licenses/LICENSE-BASE64) |
Loading