oktavia

Synopsis

Full text search engine in JavaScript environment based on FM-index algorithm.

Motivation

Write a short description of the motivation behind the creation and maintenance of the project. This should explain why the project exists.

Code Example

Use from JSX

import "oktavia.jsx";

class _Main {
    static function main(argv : string[]) : void
    {
        // Write simple usage here!
    }
}

Use from node.js

var oktavia = require('oktavia.common.js').oktavia;

// Write simple usage here!

Use from require.js

// use oktavia.amd.js
define(['oktavia'], function (oktavia) {

    // Write simple usage here!
});

Use via standard JSX function

<script src="oktavia.js" type="text/javascript"></script>
<script type="text/javascript">
window.onload = function () {
    var classObj = JSX.require("src/oktavia.js").oktavia;
    var obj = new classObj();
});
</script>

Use via global variables

<script src="oktavia.global.js" type="text/javascript"></script>
<script type="text/javascript">
window.onload = function () {
    var obj = new oktavia.oktavia();
});
</script>

Installation

$ npm install oktavia

API Reference

Write reference here!

Development

JSX

Don't be afraid JSX! If you have an experience of JavaScript, you can learn JSX quickly.

Static type system and unified class syntax.
All variables and methods belong to class.
JSX includes optimizer. You don't have to write tricky unreadalbe code for speed.
You can use almost all JavaScript API as you know. Some functions become static class functions. See reference.

Setup

To create development environment, call following command:

$ npm install

Repository

Repository: git://github.com/shibukawa/oktavia.git
Issues: https://github.com/shibukawa/oktavia/issues

Run Test

$ grunt test

Build

$ grunt build

Generate API reference

$ grunt doc

Author

shibukawa / yoshiki@shibu.jp

License

MIT

Complete license is written in LICENSE.md.

tuchida/oktavia