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

Fix README.md #237

Merged
merged 3 commits into from
Feb 27, 2020
Merged

Fix README.md #237

merged 3 commits into from
Feb 27, 2020

Conversation

MasashiYokota
Copy link
Contributor

Thank you for this awesome project.

I've found that a part of README about Usage is a little out-of-date.
I've fixed the README based on this post of Elixir Forum.

If you know other better ways about this or have any questions, please give me some comments.
Thank you.

@whitfin
Copy link
Owner

whitfin commented Feb 12, 2020

Hi @MasashiYokota!

I'm fine with this, but I would like to keep the old example, since it's still valid. Maybe you can change it to something like this:

The typical use of Cachex is to set up using a Supervisor, so that it can be handled automatically:

Supervisor.start_link(
  [
    %{
      id: :my_cache_id,
      start: {Cachex, :start_link, [:my_cache, []]}
    }
  ]
)

If you are using Elixir versions prior to Elixir v1.5, you are able use the older syntax:

Supervisor.start_link(
  [ worker(Cachex, [:my_cache, []]) ]
)

@MasashiYokota
Copy link
Contributor Author

@whitfin
Thank you for your comment.
I've modified README. Please confirm it.

@MasashiYokota
Copy link
Contributor Author

@whitfin
I understand you are very busy, but I'm glad if you confirm my PR.

@whitfin whitfin merged commit a0f2417 into whitfin:master Feb 27, 2020
@MasashiYokota MasashiYokota deleted the fix-readme-usage branch February 28, 2020 03:45
@krainboltgreene
Copy link

@whitfin How can I help get this published?

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

3 participants