Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: improve usage examples #421

Merged
merged 2 commits into from
Jan 7, 2020
Merged

docs: improve usage examples #421

merged 2 commits into from
Jan 7, 2020

Conversation

lidel
Copy link
Member

@lidel lidel commented Jan 6, 2020

This PR addresses problems raised in ipfs/ipfs-webui#1353 (comment)

This PR:

  • improves Usage docs
    • added code example for createController
    • improved example for createFactory to show the value of shared factory template
  • fixed return type of createController in docs

add one for createController, improve createFactory
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Co-Authored-By: Hugo Dias <hugomrdias@gmail.com>

License: MIT
Signed-off-by: Marcin Rataj <lidel@lidel.org>
@lidel lidel merged commit 7dad936 into master Jan 7, 2020
@lidel lidel deleted the docs/readme-improvements branch January 7, 2020 12:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants