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

Mention Inky.EEPROM.read/0 in readme and improve Display typespec #41

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

mnishiguchi
Copy link
Contributor

This is a minor enhancement.

  • Mention Inky.EEPROM.read/0 in readme
  • Add types to Inky.Display
    • variant
    • color
  • correct Elixir syntax in the last line of the "Brief example"

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved

```elixir
Inky.EEPROM.read()
```
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You probably should mention what one could do with this information below the example.

lib/display/display.ex Show resolved Hide resolved
@mnishiguchi mnishiguchi force-pushed the mnishiguchi/improve-readme branch 2 times, most recently from 4987d66 to f23a4b0 Compare November 9, 2021 13:36
@mnishiguchi mnishiguchi force-pushed the mnishiguchi/improve-readme branch from f23a4b0 to cea6163 Compare November 9, 2021 13:39
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.

2 participants