reflux/refluxjs

Can we have an API reference?

オープン

#291 opened on 2015/03/14

 (6 件のコメント) (0 件のリアクション) (0 人の担当者)JavaScript (354 件のフォーク)batch import
enhancementhelp wanted

Repository metrics

Stars
 (5,377 個のスター)
PR merge metrics
 (PR metrics pending)

説明

As well as the general readme, I think reflux should have an API.md file that would list the properties of the definition objects that you pass into createStore, createAction etc. as well as their methods.

At the moment, even Store#getInitialState isn't even mentioned in the readme, which is very confusing. I would be happy to make a PR, but I'm sure someone with a better knowledge of the codebase would make a better API reference.

コントリビューターガイド