1 [![npm](https://img.shields.io/npm/v/oojs.svg?style=flat)](https://www.npmjs.com/package/oojs) [![David](https://img.shields.io/david/dev/wikimedia/oojs.svg?style=flat)](https://david-dm.org/wikimedia/oojs#info=devDependencies)
6 OOjs is a JavaScript library for working with objects.
8 Key features include inheritance, mixins and utilities for working with objects.
10 <pre lang="javascript">
19 oo.inheritClass( Unicorn, Animal );
20 oo.mixinClass( Unicorn, Magic );
27 This library is available as an [npm](https://npmjs.org/) package! Install it right away:
32 Or clone the repo, `git clone https://phabricator.wikimedia.org/diffusion/GOJS/oojs.git`.
37 OOjs requires a modern ECMAScript 5 environment. It is not necessarily compatible with ES3 engines (such as for IE 6-8). For ES3 environments, the old 1.x releases are available but not recommended.
42 If your project uses jQuery, use the optimised `oojs.jquery.js` build instead.
44 This build assumes jQuery is present and omits various chunks of code in favour of references to jQuery.
46 jQuery 3.0.0 or higher is required.
51 We use the Semantic Versioning guidelines as much as possible.
53 Releases will be numbered in the following format:
55 `<major>.<minor>.<patch>`
57 For more information on SemVer, please visit http://semver.org/.
62 Found a bug? Please report it in the [issue tracker](https://phabricator.wikimedia.org/maniphest/task/edit/form/1/?projects=OOjs)!
71 $ git checkout -B release -t origin/master
74 $ npm install && npm test
76 # Avoid using "npm version patch" because that creates
77 # both a commit and a tag, and we shouldn't tag until after
78 # the commit is merged.
80 # Update release notes
81 # Copy the resulting list into a new section on History.md
82 $ git log --format='* %s (%aN)' --no-merges --reverse v$(node -e 'console.log(require("./package.json").version);')...HEAD
85 # Update the version number
89 $ git commit -m "Tag vX.X.X"
94 $ git checkout origin/master