juicer / readme.txt

readme.txt in Juicer.io: Effortlessly embed, curate, and aggregate social media feeds into your website 1.7, at readme.txt

155 lines 7.4 KB

Raw Download Zip

1	=== Juicer: Show all your social media posts in a beautiful feed. ===
2	Contributors: weckersham
3	Tags: social media feed, social media analytics, social media embed, social media aggregator, social media embed, embed social media, social hub, social, media, hash tag, hashtag, aggregate, aggregator, Facebook, Twitter, Instagram, YouTube, Google Plus, Tumblr, Pinterest, Vine, Soundcloud, RSS, LinkedIn, Linked In, Flickr, Vimeo, Yelp, Deviant Art, DeviantArt, autoblog, autoblogger, feed aggregator, hashtag aggregator, hash tag aggregator, widget, hashtag widget, hash tag widget, social widget, social media widget, sidebar
4	Donate link: http://www.juicer.io
5	Requires at least: 3.0
6	Tested up to: 4.3
7	Stable tag: 1.7
8	License: GPLv2
9
10	Aggregate and embed your social media posts on your site (Facebook, Twitter, Instagram, Vine, Pinterest and many more) as a beautiful feed.
11
12	== Description ==
13	Juicer is a service that allows you to enter in the name of your social media accounts (or, if you prefer, hashtags) and Juicer will automatically pull the posts from these feeds and embed them into any of your pages with an easy shortcode. Juicer will automatically update these feeds whenever you create posts for your social media accounts.
14
15	To use this plugin you must create an account on [http://www.juicer.io](http://www.juicer.io). Then you must create a feed and add social media sources to it.
16
17	= Features =
18
19	* A beautiful feed of your social media content from basically networks: Facebook, Twitter, Instagram, YouTube, Google Plus, Tumblr, Pinterest, Tumblr, Vine, RSS, LinkedIn, Flickr, Vimeo, Hashtags, Yelp and DeviantArt.
20	* Gather your content by @username or #hashtag
21	* Setup rules & filters to automatically eliminate unwanted content retweets and duplicate posts.
22	* Moderate and remove your social media content with one click.
23	* Permalinks to each of your social media posts, optimized for SEO.
24	* Responsive grid for dynamic layouts.
25	* Infinite scroll: load more content simply by scrolling to the bottom of the page.
26	* Auto-approve all your user generated content, or set up auto-moderation filters.
27	* Custom CSS: Style it to fit your brand or site.
28	* Advanced Analytics: Find out who uses your social feed, and how they interact with it.
29
30	Visit [http://www.juicer.io](http://www.juicer.io) for more information
31
32	== Installation ==
33	Download the plugin zip file, unzip it, and upload it to your wordpress site under the /wp-includes/plugins directory.
34
35	Sign up via [http://www.juicer.io](http://www.juicer.io) and create a feed for free
36
37	One you've done that you can use the shortcode: `[juicer name='YOUR_FEED_NAME']` in any post or page
38
39	To get your Juicer feed name:
40
41	- Sign into your account on http://www.juicer.io
42	- Navigate to http://www.juicer.io/feeds
43	- Click "Edit" on the feed you wish to embed
44	- You should be taken to a url like http://www.juicer.io/feeds/juicer
45	- The 'juicer' portion of the url is your feed name.
46	- To use a shortcode for the embed feed try `[juicer name='juicer']`
47	- Make sure you replace the `name` above with your feeds name.
48
49	Alternately, you can add the feed to your template directly if you like using PHP. Here's an example: `<?php juicer_feed('name=juicer'); ?>`
50
51	= Advanced Usage =
52
53	There are a few more parameters you can add to your shortcode / php function that will allow you to limit the number of posts that show up:
54
55	`per`is the number of posts you want to show up on a page. Default is 100
56
57	`pages` is the number of times you want the feed to add more posts as you scroll (This is known as infinite scroll). By default there is no limit to the number of pages, it will keep going until you've seen all the posts in your feed. If you only want it to add more posts once as you scroll set this to "2" for example.
58
59	So if you wanted your feed to only ever display 15 posts you should do something like this:
60
61	`[juicer name='YOUR_FEED_NAME' per='15' pages='1']`
62
63	or
64
65	`<?php juicer_feed('name=juicer&per=15&pages=1'); ?>`
66
67	This will show 15 posts, and ensure that your feed doesn't load any posts beyond the first page.
68
69	== Frequently Asked Questions ==
70
71	= What is Juicer? =
72	[Juicer](http://www.juicer.io) is a service that allows you to create an embeddable feed of all your social media accounts. It's great for increasing brand awareness and engagment and for providing fresh and interesting content for your website with very little work. It auto updates every day, pulling in any new posts, so your feed will always be fresh with your latest social media posts.
73
74	= How much does it cost? =
75	Juicer is free forever. No really! There is a paid account that gives you added features like adding more social media accounts, creating multiple feeds and getting detailed social analytics. But if you just want a feed for your website, it's free forever!
76
77	= I only want a few posts showing up, not a huge feed! =
78	Not a problem! There's a few different ways we can handle this:
79
80	Use our widget: Log on to your [Juicer account](http://www.juicer.io) and click on "Edit" for your feed. Then click on "Feed Settings" and change your "Feed Style" to "Widget". This specific style shows just a single post at a time, and slides through them. It's simple and beautiful and perfect for putting in a sidebar or a footer, without taking up as much room as a normal juicer feed.
81
82	Limit the number of posts: If you want to use a normal Juicer feed, but you don't want it to be super long there are some additional attributes you can pass into the short code or function `per` and `pages`:
83
84	`per` is the number of posts you want to show up on a page. Default is 100
85
86	`pages` is the number of times you want the feed to add more posts as you scroll (This is known as infinite scroll). By default there is no limit to the number of pages, it will keep going until you've seen all the posts in your feed. If you only want it to add more posts once as you scroll set this to "2" for example.
87
88	So if you wanted your feed to only ever display 15 posts you should do something like this:
89
90	`[juicer name='YOUR_FEED_NAME' per='15' pages='1']`
91
92	or
93
94	`<?php juicer_feed('name=juicer&per=15&pages=1'); ?>`
95
96	This will show 15 posts, and ensure that your feed doesn't load any posts beyond the first page.
97
98	Make sense? If not, [Contact Us](http://www.juicer.io) and we'll help you out.
99
100	= It's not working for me! =
101	Sorry to hear that! Give us a shout on our [Contact Page](http://www.juicer.io) and we'll help you out!
102
103	Make sure that if your site has jQuery it is using at least version 1.7
104
105	Make sure that all Javascript errors are resolved.
106
107	== Screenshots ==
108	1. An example Juicer Feed using a provided template
109	2. A Juicer feed with custom CSS
110	3. The Juicer Feed Edit with all the functionality you are able to use.
111
112	== Changelog ==
113
114	= 1.7 =
115	* Don't show Juicer Branding for paid users
116
117	= 1.6.1 =
118	* Map attributes better, clean up code, support older versions of php
119
120	= 1.6 =
121	* Dynamically generating <ul> based on passed in attributes.
122
123	= 1.5 =
124	* Adding "after" callback
125
126	= 1.4.1 =
127	* Fixing bug with infinite scroll
128
129	= 1.4 =
130	* Making sure shortcode returns at proper place in page.
131
132	= 1.3.1 =
133	* Bug fix
134
135	= 1.3 =
136	* Making sure Juicer Scripts get called at the top of the head
137
138	= 1.2 =
139	* No longer need to specify number of columns. Instead control this in your http://www.juicer.io feed editor.
140
141	= 1.1.2 =
142	* Embed js no longer includes jQuery, instead it is enqueued into the theme by wordpress.
143
144	= 1.1.1 =
145	* Fixing bug in juicer_feed php function
146
147	= 1.1 =
148	* Updating default feed
149
150	= 1.0 =
151	* Initial Version
152
153	== Upgrade Notice ==
154	No problems should be encountered when upgrading.
155