jenkins-bot has submitted this change and it was merged. Change subject: README.md: Update introduction, badges, advice ......................................................................
README.md: Update introduction, badges, advice Change-Id: I9b9053069e1b9e68eb964e18ed024d7687bfe7ce --- M README.md 1 file changed, 20 insertions(+), 3 deletions(-) Approvals: Trevor Parscal: Looks good to me, approved jenkins-bot: Verified diff --git a/README.md b/README.md index fff4cbd..6a75daf 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,21 @@ -[](https://badge.fury.io/js/oojs-ui) [](https://david-dm.org/wikimedia/oojs-ui#info=devDependencies) +[](https://badge.fury.io/js/oojs-ui) [](https://david-dm.org/wikimedia/oojs-ui#info=devDependencies) +OOjs UI ================= + +OOjs UI is a modern JavaScript UI toolkit for browsers. It provides a library of common widgets, layouts and windows that are ready to use, as well as many foundational classes for constructing custom user interfaces. The library was originally created for use by [VisualEditor](https://www.mediawiki.org/wiki/VisualEditor), which uses it for its entire user interface, and is now completely independent, and more useful and convenient for other use cases. Quick start ---------- + +Quick start +---------- + +This library is available as an [npm](https://npmjs.org/) package! Install it right away: +<pre lang="bash"> +npm install oojs-ui +</pre> + +If you don't want to use npm, you can: 1. Clone the repo, `git clone https://git.wikimedia.org/git/oojs/ui.git`. @@ -11,6 +24,7 @@ 1. Install dev dependencies and build the distribution files:<br/>`$ npm install` 1. You can now copy the distribution files from the dist directory into your project. + Versioning ---------- @@ -23,16 +37,17 @@ For more information on SemVer, please visit http://semver.org/. + Bug tracker ----------- Found a bug? Please report it in the [issue tracker](https://bugzilla.wikimedia.org/enter_bug.cgi?product=OOjs+UI)! + Release ---------- Release process: - <pre lang="bash"> $ cd path/to/oojs-ui/ $ git remote update @@ -47,9 +62,11 @@ # Update release notes # Copy the resulting list into a new section on History.md -$ git log --format='* %s (%aN)' --no-merges --reverse v$(node -e 'console.log(JSON.parse(require("fs").readFileSync("package.json")).version);')...HEAD +$ git log --format='* %s (%aN)' --no-merges --reverse v$(node -e 'console.log(require("./package.json").version);')...HEAD $ edit History.md +node -e 'console.log(require(package.json).version);' + # Update the version number $ edit package.json -- To view, visit https://gerrit.wikimedia.org/r/175191 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: I9b9053069e1b9e68eb964e18ed024d7687bfe7ce Gerrit-PatchSet: 1 Gerrit-Project: oojs/ui Gerrit-Branch: master Gerrit-Owner: Jforrester <jforres...@wikimedia.org> Gerrit-Reviewer: Trevor Parscal <tpars...@wikimedia.org> Gerrit-Reviewer: jenkins-bot <> _______________________________________________ MediaWiki-commits mailing list MediaWiki-commits@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
