forked from Automattic/liveblog
-
Notifications
You must be signed in to change notification settings - Fork 1
/
readme.txt
118 lines (82 loc) · 4.01 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
=== Liveblog ===
Contributors: automattic, nbachiyski, batmoo, johnjamesjacoby
Tags: liveblog
Requires at least: 3.5
Tested up to: 3.5
Stable tag: 1.3
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
Quick and simple blogging for following fast-paced events.
== Description ==
[wpvideo tWpw6nCt]
Your readers want your updates as quickly as possible, and we think we provide the easiest and the most flexible publishing environment to make that happen. Sometimes though, that’s just not enough.
When you’re covering a fast-paced event — the latest Apple unveiling, an F1 Grand Prix, or the Super Bowl — a full blog post for each individual update is a poor experience for your authors and your audience.
The [WordPress.com VIP Liveblog Add-On](http://vip.wordpress.com/liveblog-add-on/) was purpose-built to address these issues specifically.
Here’s what makes it special:
* Post updates right from the front-end of your site (no need to use the `/wp-admin` dashboard)
* Viewers of your Liveblog get new entries served to them instantly and automatically, without needing to refresh their browser.
* Your authors can drag-and-drop photos right into the Liveblog area, without needing to navigate to separate browser tabs or windows.
* There’s no need for a separate site dedicated to liveblogging: *every* post can be a liveblog, even existing ones.
[Check out our in-depth documentation.](http://vip.wordpress.com/documentation/using-the-liveblog-plugin/)
If you'd like to check out the code and contribute, [join us on github](https://github.com/Automattic/liveblog), pull requests are more than welcome.
== Installation ==
1. Upload the `liveblog` folder to your plugins directory (e.g. `/wp-content/plugins/`)
2. Activate the plugin through the 'Plugins' menu in WordPress
3. You can enable the liveblog on any post's edit page
== Screenshots ==
1. The entry form is the simplest possible
2. Writers can preview before posting
4. New posts are highlighted
5. Adding images is a matter of just drag-and-drop
6. Dragged photos are automatically inserted
8. Typical liveblog view
== Running the JavaScript tests ==
The JavaScript unit tests are run with karma:
http://karma-runner.github.io/
Install the mergejs shell script:
cd bin
wget https://raw.github.com/eloone/mergejs/master/mergejs
chmod +x mergejs
Generate the initial bundle:
bin/bundle
Install test dependecies:
cd test
npm install
Run karma:
cd test
./node_modules/.bin/karma start
== Changelog ==
= 1.3 =
**The liveblog plugin now requires WordPress 3.5.**
New functionality:
* Liveblog archiving
* Shows automatically new entries, with a slick notification bar if we have scrolled out of view. With the help of [@borkweb](https://github.com/borkweb) and [@zbtirrell](https://github.com/zbtirrell)
* Front-end editing
* Pasting an image URL embeds the image
Translations:
* German by [@cfoellmann](https://github.com/cfoellmann)
* Spanish by [@elarequi](http://profiles.wordpress.org/elarequi)
Also a lot of internal improvements and bug fixes. See the [full list of
closed issues](https://github.com/Automattic/liveblog/issues?milestone=3&state=closed).
= 1.2 =
New functionality:
* Introduce many new hooks and filters, which help customization without changing the plugin code.
* Allow shortcodes and OEmbed in liveblog entries
* Translations:
- Spanish by [@elarequi](http://profiles.wordpress.org/elarequi)
- Dutch by [@defries](https://github.com/defries)
- Catalan by [@gasparappa](https://github.com/gasparappa)
- German by [@cfoellmann](https://github.com/cfoellmann)
* Add github-friendly version of `readme.txt`
* Optimize PNG files
Fixed problems:
* Fix JavaScript errors on IE8, props [@pippercameron](https://github.com/pippercameron)
* Fix preview tab
* Compatibility with plupload 1.5.4, props [@borkweb](https://github.com/borkweb)
= 1.1 =
* Backwards compatibility for 3.4
* Support for non-pretty permalinks
* Support for permalinks without trailing slashes
* Fix preview tab
= 1.0 =
* Initial release