Skip to content

Commit

Permalink
Update README with privacy policy and terms of use location, edit tit…
Browse files Browse the repository at this point in the history
…le of icon
  • Loading branch information
mostlymarvin committed May 14, 2018
1 parent ae93238 commit e9f6830
Show file tree
Hide file tree
Showing 3 changed files with 84 additions and 26 deletions.
104 changes: 81 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,101 @@
# Bites4WP - A Book+Main Bites Profile Link Plugin for WordPress

- [Read Directions, Instructions, and Cautionary Tales](http://bites4wp.memphismckay.com)

## Setup:
Under Book+Main Bites in the customizer:
- **Profile Settings**: enter the username of the Book+Main Bites Profile you would like to link to
- **Style Options**: choose colors, backgrounds, borders, and typography for the icons (these options apply to both the floating icon and the widget icon. If you need to style them separately, you can use the custom css box to add additional styles as needed.)
- **Display Options**: applies to floating icon only. Choose to display on all pages, home page only, or hide completely.
-- If set to show on home or all, choose the position of the icon on the desktop (defaults to the right side of your screen in the center), along with the position on mobile (defaults to the bottom of the page).
### Read Directions, Instructions, and Cautionary Tales:
http://bites4wp.memphismckay.com


## Shortcode:
### Install
- [Download zip file](https://github.com/mostlymarvin/bites4wp/archive/master.zip)
- In your WordPress dashboard, go to **Plugins** and **Add New**
- Upload zip file
- Activate

### Configure
Open the Customizer Panel (accessible from the Admin Dashboard under **Appearance -> Customize** OR from the **Customizer** link in the admin bar at the top of the site), then click on **Book+Main**.

- **Profile Settings**
- Add your Book+Main username
- **Style Options**
- Set your design preferences. These apply to both the shortcode and to the floating icon. (Typography preferences only apply to the shortcode)
- **Display Options**
- Choose whether you'd like the floating icon to display everywhere, on home only, or disable the floating icon entirely.
- Choose the position the icon will have on desktop browser windows
- Choose the position the icon will have on smaller screens

### Shortcode Use
To display the Book+Main Bites link in a page, post, or (if your theme allows) a widget, use the shortcode `[bites_link]`.


#### Shortcode Parameters:
- **username** : by default, the username you specified in the customizer will be used, but if you'd like to link to another profile, you can add it to the shortcode parameters.
- **text** : default text is "follow me on book+main bites". To change this, add a "text" parameter to your shortcode.
- **align** : by default, the shortcode link will be centered. Just like WordPress images, though, you may also set this parameter to "left", "right", or "none".
- **class** : should you need to add an additional css class to the shortcode, you can add a class (or space-separated classes) to this parameter.

#### Using the Shortcode in Template Files:
```
[bites_link username='' text='' align='']
if( shortcode_exists('bites_link' ) ) {
echo do_shortcode('[bites_link'] );
}
```
- **username** defaults to the username entered into customizer (above), but if you'd like to display a link elsewhere, add the username here
- **text** defaults to "Follow me on Book+Main Bites", but can be customized.
- **align** defaults to center, but can be set "left", "right", or "none" ( similar to image alignment )
- **class** defaults to empty, but a custom css class can be added if needed

you can also use the shortcode in a theme template:
#### Shortcode Examples

```
if( shortcode_exists('bites_link' ) ) {
echo do_shortcode('[bites_link'] );
}
[bites_link username="janefonda"]
```

```
[bites_link text="come hang out with me at book+main!"]
```

```
[bites_link class="class1 class2"]
```

```
[bites_link align="left"]
```


### Questions?
[Contact Me Here](https://memphismckay.com/contact) - I'll do my best to help, if I can. In your message, please try to be as _specific as possible_ about the issue you are experiencing, and if possible, include a link to your website. **Please note that while I hope this plugin will be useful to you, I cannot guarantee this plugin will be error free, will work with all themes, or that it will never burn your toast or curse in front of your children, though I've tried to teach it better manners than that.**
### Updates
Periodically, you may see update notifications. It is always a best practice to make sure you keep your plugins up to date.


### Support & Questions
Questions? [Contact Me Here](/contact) - I'll do my best to help, if I can. In your message, please include a link to your website, and try to be as specific as possible about the issue you are experiencing.

Memphis McKay, LLC distributes Bites4WP and other plugins "as is" and with no guarantee, explicit or implied, that they will function exactly as you would like, or that they will be compatible with all third-party components and plugins. We have seen no evidence that this or any other of our plugins can do laundry or provide adequete child supervision, so we do not recommend them for these uses.

While it is our intent to provide the speediest and best support possible for our product(s), we do not guarantee that any particular support query can or will be answered to the satisfaction of the inquirer, nor do we guarantee a response within any specific timeframe. Support is provided at the sole discretion of Memphis McKay, LLC.


### Warranty
Please note that while we hope this plugin will be useful to you, we cannot guarantee this plugin will always be error free, will work with all themes, will work on all devices, or that it will never burn your toast or curse in front of your children, though we've tried to teach it better manners than that.

Plugins sold and / or distributed by Memphis McKay, LLC are done so in the hope that they will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Because the number and variety of plugins is vast and wide, we do not guarantee that the plugin will function with all third-party plugins, themes or browsers of any kind. We do not assume responsibility and will not be held responsible for any conflicts or compatibility issues that may occur due to third-party software. We assume no responsibility for any data loss as a result of installing or using Bites4WP. Should conflicts occur with third-party software, we may provide support at our discretion.


### License: GPL-2.0+
Bites4WP (c) 2018 Memphis McKay

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, version 2, as published by the Free Software Foundation.

This program is distributed in the hope that it will be useful,but WITHOUT ANY WARRANTY without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the [GNU General Public License](https://www.gnu.org/licenses/gpl-2.0.html) for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

GNU General Public License is available online, [here](https://www.gnu.org/licenses/gpl.html)


### Terms of Use Agreement
By downloading and /or using this plugin, you are you indicate and consent that you have read and agree to the [Terms & Conditions](http://bites4wp.memphismckay.com/terms/) listed and detailed on our website, here: http://bites4wp.memphismckay.com/terms/. We reserve the right to change or modify the current Terms and Conditions without prior notice or consent.


### Privacy Policy
We like our privacy. We think your privacy is important, too. You can read our full [Privacy Policy](https://www.iubenda.com/privacy-policy/35861641) here: https://www.iubenda.com/privacy-policy/35861641

4 changes: 2 additions & 2 deletions bites4wp.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
* Plugin Name: Bites4WP
* Plugin URI: http://bites4wp.memphismckay.com
* Description: Book+Main Bites Profile Link Plugin for WordPress
* Version: 1.0.6
* Version: 1.0.7
* Author: Memphis McKay
* Author URI: https://memphismckay.com
* License: GPL-2.0+
Expand Down Expand Up @@ -39,7 +39,7 @@
die;
}

define( 'BITES4WP_CURRENT_VERSION', '1.0.6' );
define( 'BITES4WP_CURRENT_VERSION', '1.0.7' );
define( 'BITES4WP_PLUGIN_DIR', plugin_dir_path( __FILE__ ) );
define( 'BITES4WP_PLUGIN_URL', plugin_dir_url(__FILE__) );
define( 'BITES4WP_PLUGIN_BASENAME', plugin_basename(__FILE__) );
Expand Down
2 changes: 1 addition & 1 deletion templates/bites4wp-svg.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

<svg version="1.1" id="bites-logo" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
viewBox="0 0 156.67 145.85" style="enable-background:new 0 0 156.67 145.85;" xml:space="preserve">
<title>Book+Main Bites Logo</title>
<title>Book+Main Bites</title>
<g id="Layer_2_1_">
<g id="Layer_1-2">
<path d="M127.39,25.29c0.002-8.011,1.944-15.903,5.66-23c0.055-0.102,0.018-0.229-0.084-0.285
Expand Down

0 comments on commit e9f6830

Please sign in to comment.