=== UK Council Home Swaps ===
Contributors: mutualhomeexchange
Tags: housing, council housing, property, home swap, local news
Requires at least: 5.8
Tested up to: 6.9
Requires PHP: 7.4
Stable tag: 1.0.0
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html

Give your readers a free panel of council and housing association homes to swap near them. Shortcode, block and widget.

== Description ==

Tenants of councils and housing associations can swap homes with each other. This plugin adds a small panel to your site showing the homes to swap nearest to your readers, with a photo, the number of bedrooms, the type of home, the rent and how far away it is. It updates itself, so you never have to touch it again.

It suits local newspapers, community websites, parish and town council sites, and local services whose readers may want to move into or out of your area.

* **Block, widget and shortcode.** Use whichever suits your theme.
* **Nearest first.** Homes inside your chosen distance come first (5 miles by default). If there are only a few, the nearest ones further afield are added under a "Further afield" heading, so the panel is never empty.
* **Private.** Only what is already public on each home's page is shown: the photo, title, bedrooms, type, rent and postcode district. Never the street. The panel sets no cookies.
* **Light, dark or automatic colours**, and your own accent colour.
* **Free.** No account, no payment, no contract. The panel carries a small "Powered by Mutual Home Exchange" link.

= Shortcode =

`[uk_council_home_swaps location="Worthing" radius="5" count="3" layout="side"]`

Options: `location` (a town or a full postcode), `radius` (1 to 50 miles), `count` (1 to 6), `layout` (`side` or `strip`), `theme` (`auto`, `light` or `dark`), `accent` (six hex digits, for example `e8a33d`), `key` (an optional partner key). Anything you leave out comes from Settings > UK Council Home Swaps.

== External services ==

This plugin shows a panel that is loaded, in a frame, from the Mutual Home Exchange service at https://www.mutualhomeexchange.co.uk. The panel is the plugin's whole purpose, so the service is needed for it to work.

* **What is sent:** when a visitor views a page with the panel, their browser requests the panel from mutualhomeexchange.co.uk. That request carries the town or postcode, distance and look you chose, the plugin version, and the address of the page showing the panel (without any query string). The service also receives the visitor's IP address and browser details, as any website does. Nothing else is sent, and nothing about the visitor is stored. The service counts how many times a panel is shown, per website and page.
* **When:** on every page view that contains the panel.
* **If a visitor opens a home**, they leave your site for mutualhomeexchange.co.uk, and its terms and privacy policy apply.
* Service: Mutual Home Exchange. Terms: https://www.mutualhomeexchange.co.uk/terms.php and, for publishers, https://www.mutualhomeexchange.co.uk/publisher-terms.php. Privacy policy: https://www.mutualhomeexchange.co.uk/privacy.php (see "Publisher panels and the WordPress plugin").
* To protect the service from abuse, each panel load is limited per visitor and per website. A one-way scrambled form of the visitor's address is held for under an hour for this, and is never stored with anything else.

== Installation ==

1. Upload the plugin and activate it, or install it from Plugins > Add New.
2. Go to Settings > UK Council Home Swaps and enter your town or postcode.
3. Add the "UK Council Home Swaps" block to a page, or the widget to a sidebar, or paste the shortcode.

== Frequently Asked Questions ==

= Does it cost anything? =

No. It is free, and so is the data.

= Can I show a different place on different pages? =

Yes. Give each block, widget or shortcode its own town or postcode.

= Does it slow my site down? =

The panel loads in a frame after your page, so it does not hold your page up.

= Why do I see homes that are not very near? =

When fewer homes than you asked for are within your distance, the nearest ones further afield are added under a "Further afield" heading, each with its distance.

= Is a partner key needed? =

No. A free key from mutualhomeexchange.co.uk/publishers.php ties the panel to your site so that no one else can copy it.

== Screenshots ==

1. The panel in a sidebar.
2. The wide layout in a page.
3. The block's settings.

== Changelog ==

= 1.0.0 =
* First release.

== Upgrade Notice ==

= 1.0.0 =
First release.
