WriteSpec

npm publish が終わったら GitHub/Wiki に Markdown で Spec(ドキュメント)を記述します。

ブラウザで https://github.com/{GitHubのユーザ名}/MyExample.js/wiki/ を開いてください。wiki のトップ(Home)を新しく書き始める事ができます。

Home (wiki top)

Home には、MyExample.js の概要や Spec を記述します。MyExample.js で解決したかった事、どんな事に使えるか、何かをするか、そして何かをしないかを記述してください。

MyExample.js は、WebModule の機能を説明するためのダミーライブラリです。  
WebModuleのユーザが初めて作成するモジュールになります。

MyExample (API Spec)

続いて https://github.com/{GitHubのユーザ名}/MyExample.js/wiki/MyExample ページを新規に作成します。このページには API Spec を記述していきます。

    ## new MyExample

    new MyExample(value:Number) は、MyExample クラスのインスタンスを生成します。  
    value には数値を指定します。

    ```js
    function MyExample(value) { // @arg Number: the valud.
        this._value = value;
    }
    ```


    ## MyExample.prototype.value

    MyExample#value:Any はアクセッサです。`this._value` の値を返します。

    ```js
    var my = new MyExample(123);

    console.log(my.value); // 123

    my.value = 2929;

    console.log(my.value); // 2929
    ```

Spec の記述が面倒だな… 嫌だな… と感じたら、こちらのエントリを御覧ください。