Commit 38b414ad authored by Erick Hitter's avatar Erick Hitter

Basic readme, plus grunt tasks

parent e4da09ad
# Camo Image Proxy #
**Contributors:** ethitter
**Donate link:** https://ethitter.com/donate/
**Tags:** image, proxy, cdn
**Requires at least:** 4.9
**Tested up to:** 4.9
**Stable tag:** 0.1.0
**License:** GPLv2 or later
**License URI:** https://www.gnu.org/licenses/gpl-2.0.html
Rewrite image URLs to use a Camo image proxy. Handles post content and image URLs generated by WordPress.
## Description ##
Rewrites images found in post content, and image URLs generated by WordPress, to use a Camo image proxy.
Generates path-format URLs supported by:
* https://github.com/atmos/camo
* https://github.com/cactus/go-camo
## Installation ##
1. Upload `camo-image-proxy` directory to the `/wp-content/plugins/` directory
1. Activate the plugin through the Plugins menu in WordPress
1. Set your Camo server and key under Settings > Media > Camo Proxy
## Frequently Asked Questions ##
### Why isn't Camo's query-string URL format supported? ###
The go-camo library doesn't support it, and this plugin aims to support the widest set of Camo implementations.
## Changelog ##
### 0.1.0 ###
* Initial release
# Copyright (C) 2018 Erick Hitter
# This file is distributed under the same license as the Camo Image Proxy package.
msgid ""
msgstr ""
"Project-Id-Version: Camo Image Proxy 0.1.0\n"
"Report-Msgid-Bugs-To: https://wordpress.org/support/plugin/camo-image-proxy\n"
"POT-Creation-Date: 2018-02-18 19:07:54+00:00\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=utf-8\n"
"Content-Transfer-Encoding: 8bit\n"
"PO-Revision-Date: 2018-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"X-Generator: grunt-wp-i18n 0.5.4\n"
"X-Poedit-KeywordsList: "
"__;_e;_x:1,2c;_ex:1,2c;_n:1,2;_nx:1,2,4c;_n_noop:1,2;_nx_noop:1,2,3c;esc_"
"attr__;esc_html__;esc_attr_e;esc_html_e;esc_attr_x:1,2c;esc_html_x:1,2c;\n"
"Language: en\n"
"Plural-Forms: nplurals=2; plural=(n != 1);\n"
"X-Poedit-Country: United States\n"
"X-Poedit-SourceCharset: UTF-8\n"
"X-Poedit-Basepath: ../\n"
"X-Poedit-SearchPath-0: .\n"
"X-Poedit-Bookmarks: \n"
"X-Textdomain-Support: yes\n"
#. Plugin Name of the plugin/theme
msgid "Camo Image Proxy"
msgstr ""
#. Plugin URI of the plugin/theme
msgid "https://ethitter.com/plugins/"
msgstr ""
#. Description of the plugin/theme
msgid "Rewrite image URLs to use a Camo image proxy."
msgstr ""
#. Author of the plugin/theme
msgid "Erick Hitter"
msgstr ""
#. Author URI of the plugin/theme
msgid "https://ethitter.com/"
msgstr ""
\ No newline at end of file
This diff is collapsed.
{
"name": "camo-image-proxy",
"version": "0.1.0",
......
......@@ -12,103 +12,26 @@ Rewrite image URLs to use a Camo image proxy. Handles post content and image URL
== Description ==
This is the long description. No limit, and you can use Markdown (as well as in the following sections).
Rewrites images found in post content, and image URLs generated by WordPress, to use a Camo image proxy.
For backwards compatibility, if this section is missing, the full length of the short description will be used, and
Markdown parsed.
Generates path-format URLs supported by:
A few notes about the sections above:
* "Contributors" is a comma separated list of wp.org/wp-plugins.org usernames
* "Tags" is a comma separated list of tags that apply to the plugin
* "Requires at least" is the lowest version that the plugin will work on
* "Tested up to" is the highest version that you've *successfully used to test the plugin*. Note that it might work on
higher versions... this is just the highest one you've verified.
* Stable tag should indicate the Subversion "tag" of the latest stable version, or "trunk," if you use `/trunk/` for
stable.
Note that the `readme.txt` of the stable tag is the one that is considered the defining one for the plugin, so
if the `/trunk/readme.txt` file says that the stable tag is `4.3`, then it is `/tags/4.3/readme.txt` that'll be used
for displaying information about the plugin. In this situation, the only thing considered from the trunk `readme.txt`
is the stable tag pointer. Thus, if you develop in trunk, you can update the trunk `readme.txt` to reflect changes in
your in-development version, without having that information incorrectly disclosed about the current stable version
that lacks those changes -- as long as the trunk's `readme.txt` points to the correct stable tag.
If no stable tag is provided, it is assumed that trunk is stable, but you should specify "trunk" if that's where
you put the stable version, in order to eliminate any doubt.
* https://github.com/atmos/camo
* https://github.com/cactus/go-camo
== Installation ==
This section describes how to install the plugin and get it working.
e.g.
1. Upload `plugin-name.php` to the `/wp-content/plugins/` directory
1. Activate the plugin through the 'Plugins' menu in WordPress
1. Place `<?php do_action('plugin_name_hook'); ?>` in your templates
1. Upload `camo-image-proxy` directory to the `/wp-content/plugins/` directory
1. Activate the plugin through the Plugins menu in WordPress
1. Set your Camo server and key under Settings > Media > Camo Proxy
== Frequently Asked Questions ==
= A question that someone might have =
An answer to that question.
= Why isn't Camo's query-string URL format supported? =
= What about foo bar? =
Answer to foo bar dilemma.
== Screenshots ==
1. This screen shot description corresponds to screenshot-1.(png|jpg|jpeg|gif). Note that the screenshot is taken from
the /assets directory or the directory that contains the stable readme.txt (tags or trunk). Screenshots in the /assets
directory take precedence. For example, `/assets/screenshot-1.png` would win over `/tags/4.3/screenshot-1.png`
(or jpg, jpeg, gif).
2. This is the second screen shot
The go-camo library doesn't support it, and this plugin aims to support the widest set of Camo implementations.
== Changelog ==
= 1.0 =
* A change since the previous version.
* Another change.
= 0.5 =
* List versions from most recent at top to oldest at bottom.
== Upgrade Notice ==
= 1.0 =
Upgrade notices describe the reason a user should upgrade. No more than 300 characters.
= 0.5 =
This version fixes a security related bug. Upgrade immediately.
== Arbitrary section ==
You may provide arbitrary sections, in the same format as the ones above. This may be of use for extremely complicated
plugins where more information needs to be conveyed that doesn't fit into the categories of "description" or
"installation." Arbitrary sections will be shown below the built-in sections outlined above.
== A brief Markdown Example ==
Ordered list:
1. Some feature
1. Another feature
1. Something else about the plugin
Unordered list:
* something
* something else
* third thing
Here's a link to [WordPress](https://wordpress.org/ "Your favorite software") and one to [Markdown's Syntax Documentation][markdown syntax].
Titles are optional, naturally.
[markdown syntax]: https://daringfireball.net/projects/markdown/syntax
"Markdown is what the parser uses to process much of the readme file"
Markdown uses email style notation for blockquotes and I've been told:
> Asterisks for *emphasis*. Double it up for **strong**.
`<?php code(); // goes in backticks ?>`
= 0.1.0 =
* Initial release
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment