jenkins-bot has submitted this change and it was merged. Change subject: Update README; add description of ParsoidService. ......................................................................
Update README; add description of ParsoidService. Change-Id: I5e4558ee7ee50860bfc6577a9b474bea523fd904 --- M README.md M api/ParsoidService.js 2 files changed, 15 insertions(+), 3 deletions(-) Approvals: Subramanya Sastry: Looks good to me, approved jenkins-bot: Verified diff --git a/README.md b/README.md index 580b893..37e0a5f 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,8 @@ [](https://coveralls.io/r/wikimedia/parsoid?branch=master) A combined Mediawiki and html parser in JavaScript running on node.js. Please -see (https://www.mediawiki.org/wiki/Future/Parser_development) for an overview -of the current implementation, and instructions on running the tests. +see (https://www.mediawiki.org/wiki/Parsoid) for an overview +of the project. You might need to set the NODE_PATH environment variable: @@ -30,7 +30,13 @@ npm start -More details are available at https://www.mediawiki.org/wiki/Parsoid/Setup +More installation details are available at +https://www.mediawiki.org/wiki/Parsoid/Setup + +Developer API documentation can be found at +https://doc.wikimedia.org/Parsoid/master/ +and some helpful getting-started guides are at +https://doc.wikimedia.org/Parsoid/master/ License ------- diff --git a/api/ParsoidService.js b/api/ParsoidService.js index c7328fe..f9da5d6 100644 --- a/api/ParsoidService.js +++ b/api/ParsoidService.js @@ -15,6 +15,12 @@ var uuid = require('node-uuid').v4; /** + * ParsoidService instantiates an [express](http://expressjs.com/) server + * to handle HTTP requests. + * + * For more details on the HTTP api, see the + * [guide](#!/guide/apiuse). + * * @class * @constructor * @param {ParsoidConfig} parsoidConfig -- To view, visit https://gerrit.wikimedia.org/r/232506 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: I5e4558ee7ee50860bfc6577a9b474bea523fd904 Gerrit-PatchSet: 1 Gerrit-Project: mediawiki/services/parsoid Gerrit-Branch: master Gerrit-Owner: Cscott <[email protected]> Gerrit-Reviewer: Arlolra <[email protected]> Gerrit-Reviewer: Subramanya Sastry <[email protected]> Gerrit-Reviewer: jenkins-bot <> _______________________________________________ MediaWiki-commits mailing list [email protected] https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
