Skip to content

Commit

Permalink
Update documentation, fix update PHP.
Browse files Browse the repository at this point in the history
  • Loading branch information
alexmacarthur committed May 27, 2020
1 parent d49cdb3 commit c4a20f5
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 166 deletions.
80 changes: 11 additions & 69 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,81 +2,23 @@

## Description

This is the official free WordPress plugin for [TypeIt](https://typeitjs.com), the most versatile animated typing utility on the planet. WP TypeIt allows you to easily generate typewriter effects for your website using an easy-to-configure shortcode. Place this shortcode on any post or page, and the effect will be live.
This is the official WordPress plugin for [TypeIt](https://typeitjs.com), the most versatile animated typing utility on the planet. WP TypeIt allows you to easily generate typewriter effects for your website using an easy-to-configure shortcode or Gutenberg block.

### The Perks
## License Options

- _Unobtrusive_ - All this plugin does is register a shortcode you can use in your posts.
- _Lightweight_ - TypeIt is 100% vanilla JavaScript, so it won't load any dependencies like jQuery.
- _Performance in Mind_ - TypeIt will only be enqueued if it's actually needed on the page.
- _The Real Deal_ - This plugin is created and maintained by the creator of TypeIt itself.
Use plugin in an open source or personal project for free. For commercial projects, the following licenses are available. A single license will cover use of this plugin, as well as TypeItJS itself.

### Heads Up for WP TypeIt Pro
- Single Commercial License - [Purchase Here](https://typeitjs.com/checkout/limited)
- Extended Commercial License - [Purchase Here](https://typeitjs.com/checkout/unlimited)

If you're looking to generate more advanced typewriter effects, keep an eye out for WP TypeIt Pro, which will allow you to write multiple strings per instance, build effects with a custom post type and friendly UI, and more. Stay tuned...
## Documentation

## Installation
To read the full documentation, see here: https://typeitjs.com/docs/wordpress.

1. Download the plugin and upload to your plugins directory, or install the plugin through the WordPress plugins page.
2. Activate the plugin on the 'Plugins' page.
## Need Help?

## Using the Plugin
If you're working with a custom implementation of TypeIt and would like some help, I'm available for hire. [Get in touch!](https://macarthur.me/contact)

### Make an Effect Using Shortcode Attributes
## License

You can generate a typewriter effect by using a variation of the following shortcode in a post or page, passing each setting as a shortcode attribute.

At bare minimum, you need to pass a `strings` attribute:

```
[typeit strings="Look, I'm typing a string!"]
```

There also exists a wide set of attributes you may use to customize the typing effects. For example, setting speed (in milliseconds):

```
<h2>[typeit strings="Look, I'm typing a string!" speed="500"]</h2>
```

Or, making an effect continuously loop:

```
<h2>[typeit strings="This is a string that will loop!" speed="100" loop="true"]</h2>
```

### Define Strings in an SEO-Friendly Way

As demonstrated, you can define a string to be typed by passing it in as a "strings" attribute. However, you may also define them by passing them inside of two enclosing shortcode tags:

```
[typeit speed="300"]This string will exist in your HTML, and when the page is loaded, TypeIt will take over and animate it.[/typeit]
```

When the tag is rendered, that string will be hard-coded on the page, rather than stored in memory on page load. The advantage to this approach is that web crawlers will be able to parse the text without JavaScript, making the content a bit more SEO-friendly.

### View All Available Options

For the full list of options you may pass, refer to the documentation at [typeitjs.com/docs#options](https://typeitjs.com/docs#options).

### Changelog

## 1.0.0

- Initial release.

## 1.0.1

- Improve documentation.
- Add unit testing for increased code reliability.
- Fix bug causing camel-cased shortcode attributes to work improperly.

## 1.0.2

- Improve code structure.
- Make code more easily hookable for developers.

## Feedback

You like it? [Email](mailto:alex@macarthur.me) or [tweet](http://www.twitter.com/amacarthur) me. You hate it? [Email](mailto:alex@macarthur.me) or [tweet](http://www.twitter.com/amacarthur) me.

Regardless of how you feel, your review would be greatly appreciated!
[GPL-2.0](https://github.com/alexmacarthur/typeit/blob/master/LICENSE) © Alex MacArthur
94 changes: 0 additions & 94 deletions readme.txt

This file was deleted.

6 changes: 3 additions & 3 deletions src/hooks/update.php
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,9 @@ function push_update($updatePlugins)
$updatePlugins->response = [];
}

// if (get_transient(TYPEIT_UPDATE_CHECK_TRANSIENT)) {
// return $updatePlugins;
// }
if (get_transient(TYPEIT_UPDATE_CHECK_TRANSIENT)) {
return $updatePlugins;
}

$pluginData = wp_remote_get(
'https://wp-plugin-update.now.sh/api/plugin/wp-typeit',
Expand Down

0 comments on commit c4a20f5

Please sign in to comment.