Skip to content

docs: Add Contributing and package.json files, and some small edits #3

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 2 commits into from
Jul 23, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Contributing

Please conform to the [Code of Conduct](CODE_OF_CONDUCT.md).

### Note on Patches/Pull Requests

* Fork the project.
* Make your feature addition or bug fix.
* Commit, do not mess with version, or history.
(if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
* Send me a pull request. Bonus points for topic branches.
16 changes: 12 additions & 4 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
# Split.js

Split.js is a clientside A/B testing library.
> 📉 Clientside A/B testing library

Currently split.js uses google analytics as the datastore for experiments, this may be extended to handle multiple data stores in the future.
Currently split.js uses Google Analytics as the datastore for experiments, this may be extended to handle multiple data stores in the future.

## Install

Put this file somewhere in your dependency path.

## Usage

Expand Down Expand Up @@ -46,6 +50,10 @@ it may not work inside `$(document).bind("ready", handler)` or an async loader.

* You can provide as many alternatives as you like but sample size will be much lower and take longer to show real results.

## Contribute

Please conform to the [Code of Conduct](CODE_OF_CONDUCT.md).

### Note on Patches/Pull Requests

* Fork the project.
Expand All @@ -54,6 +62,6 @@ it may not work inside `$(document).bind("ready", handler)` or an async loader.
(if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
* Send me a pull request. Bonus points for topic branches.

## Copyright
## License

Copyright (c) 2013 Andrew Nesbitt. See [LICENSE](https://github.com/splitrb/split.js/blob/master/LICENSE) for details.
Copyright (c) 2013-2018 Andrew Nesbitt. See [LICENSE](https://github.com/splitrb/split.js/blob/master/LICENSE) for details.
25 changes: 25 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"name": "split-testing",
"version": "1.0.0",
"description": "📉 Clientside A/B testing library",
"main": "split.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"repository": {
"type": "git",
"url": "git+https://github.com/splitrb/split.js.git"
},
"keywords": [
"split",
"ab",
"testing",
"clientside"
],
"author": "Andrew Nesbitt",
"license": "MIT",
"bugs": {
"url": "https://github.com/splitrb/split.js/issues"
},
"homepage": "https://github.com/splitrb/split.js#readme"
}