Skip to content

Fix references in README #41

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

Closed
wants to merge 1 commit into from
Closed

Fix references in README #41

wants to merge 1 commit into from

Conversation

williamgrosset
Copy link

Overview

This PR introduces changes to the README.md:

  • Removes reference for UMD module
  • Fixes reference for blinking animation stylesheet

Also, I'm working with a project that's not using sass, so I just used the compiled version directly:

.Typist .Cursor {
  display: inline-block;
}

.Typist .Cursor--blinking {
  opacity: 1;
  animation: blink 1s linear infinite;
}

@keyframes blink {
  0% {
    opacity: 1;
  }
  50% {
    opacity: 0;
  }
  100% {
    opacity: 1;
  }
}

Thanks again for the package — cheers!

@williamgrosset williamgrosset changed the title Nit: Fix stylesheet reference in README Nit: Fix references in README Mar 11, 2018
@williamgrosset williamgrosset changed the title Nit: Fix references in README Fix references in README Mar 11, 2018
@@ -32,16 +32,11 @@ export default class MyComponent extends Component {
}
```

#### UMD module:
Copy link
Owner

Choose a reason for hiding this comment

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

hey! I'm not sure why we removed this. Is the file not available in the npm package?

<a name="cssBlink"></a>
#### CSS
Typist contains a simple CSS file to make the cursor at the end of the text
blink. To include it, you must include
[`dist/Typist.css`](/dist/Typist.css) in your build.

[`src/Cursor.scss`](/src/Cursor.scss) in your build.
Copy link
Owner

Choose a reason for hiding this comment

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

hmmm, I'm not sure this is correct. we were previously pointing people to the compiled .css version, right?

@williamgrosset
Copy link
Author

Hey @jstejada — don't worry about this PR. I had build issues when I ran this last night, and assumed dist/ was completely gone due to this comment. I re-ran the script and everything was fine. 👍

homer
:)

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