Update README - important notes, notifications on new releases and others.

cztomczak · cztomczak · commit edac70bf45d7 · 2016-10-12T07:52:57.000+02:00
Update the "Changes in API during updates" section.

Update examples/ with comments that specify CEF Python version these
examples were tested with.
diff --git a/README.md b/README.md
@@ -5,21 +5,29 @@
 [![](https://img.shields.io/badge/pypi-v31.2-blue.png "PyPI latest release")](https://pypi.python.org/pypi/cefpython3/)
 [![](https://img.shields.io/badge/commits%20since-v31.2-lightgray.png "Commits since v31.2 release")](https://github.com/cztomczak/cefpython/compare/05366f2...master)
 
-__Important notes__:
-* Branches cefpython51/52/53+ with latest Chrome are tested and work only on Linux currently.
-  Instructions for building these are in docs/[Build-instructions.md](docs/Build-instructions.md)
-* The last stable release that works on all platforms is in the cefpython31 branch.
-  Up-to-date API docs for the cefpython31 branch can be viewed in commit [169a1b2](https://github.com/cztomczak/cefpython/tree/169a1b20d3cd09879070d41aab28cfa195d2a7d5/docs/api).
-* Repository rewritten on 2016-02-15 to reduce its size. Please clone it again.
-
 Table of contents:
+* [Important notes](#important-notes)
 * [Introduction](#introduction)
 * [Compatibility](#compatibility)
 * [Downloads](#downloads)
 * [Support](#support)
+* [Notifications on new releases](#notifications-on-new-releases)
 * [Changes in API during updates](#changes-in-api-during-updates)
 * [Donate](#donate)
 
+## Important notes
+
+* Branches cefpython51/52/53+ with latest Chrome are tested and work only
+  on Linux currently. Instructions for building these are
+  in docs/[Build-instructions.md](docs/Build-instructions.md).
+  Beta downloads are available on the [Github Releases](../../releases) page.
+  Pre-releases are also available on PyPI.
+* The last stable release that works on all platforms is in the cefpython31
+  branch. Downloads for this branch are available on wiki pages. Up-to-date
+  API docs for the cefpython31 branch can be viewed in commit 
+  [169a1b2](https://github.com/cztomczak/cefpython/tree/169a1b20d3cd09879070d41aab28cfa195d2a7d5/docs/api).
+* Repository rewritten on 2016-02-15 to reduce its size. Please clone it again.
+
 
 ## Introduction
 
@@ -35,7 +43,8 @@ Some use cases for CEF:
 
 ## Compatibility
 
-* Supported Python versions: 2.7. For Python 3.4 / 3.5 support see [Issue #121](../../issues/121).
+* Supported Python versions: 2.7
+  (for Python 3.4 / 3.5 support see [Issue #121](../../issues/121)).
 * Supported platforms: Windows, Linux, Mac. Both 32bit and 64bit binaries are available for all platforms.
 
 
@@ -48,8 +57,8 @@ On Win/Mac you can install from PyPI using this command:
 * For Linux: see the [Download_CEF3_Linux](../../wiki/Download_CEF3_Linux) wiki page.
 * For Mac: see the [Download_CEF3_Mac](../../wiki/Download_CEF3_Mac) wiki page.
 
-__New releases RSS/Atom feed__<br>
-To be notified of new releases subscribe to this [Atom feed](https://github.com/cztomczak/cefpython/releases.atom).
+To be notified when new downloads are available see the
+[Notifications on new releases](#notifications-on-new-releases) section.
 
 
 ## Support
@@ -64,6 +73,17 @@ To be notified of new releases subscribe to this [Atom feed](https://github.com/
 * Please do not ask questions in the Issue Tracker
 
 
+## Notifications on new releases
+
+To be notified of new releases subscribe to this
+[RSS/Atom feed](https://github.com/cztomczak/cefpython/releases.atom).
+
+Announcements are also made on the
+[Forum](https://groups.google.com/d/forum/cefpython).
+To be notified of these via email set your Membership and Email settings
+and change delivery preference to Daily summaries.
+
+
 ## Changes in API during updates
 
 CEF Python depends on CEF and API breaks are inevitable when updating
@@ -73,6 +93,12 @@ and check release notes for all the releases that appeared between
 your old version and the new version. Look for lists named
 "Changes in API that break backward compatibility".
 
+Due to unavoidable changes in API it is recommended for your setup scripts
+that use for example PIP to install the cefpython3 package, to hardcode
+the cefpython version string. If for example using PIP's requirements.txt
+file then list the cefpython3 package in the following format:
+`cefpython3 == 31.2`.
+
 
 ## Donate
 
diff --git a/examples/gtk.py b/examples/gtk.py
@@ -1,5 +1,5 @@
 # Example of embedding CEF Python browser using PyGObject/Gtk library.
-# Tested with GTK 3.10.
+# Tested with GTK 3.10 and CEF Python v53+.
 
 from cefpython3 import cefpython as cef
 # noinspection PyUnresolvedReferences
diff --git a/examples/hello_world.py b/examples/hello_world.py
@@ -1,4 +1,5 @@
 # Hello world example. Doesn't depend on any third party GUI framework.
+# Tested with CEF Python v53+.
 
 from cefpython3 import cefpython as cef
 import sys
diff --git a/examples/tkinter_.py b/examples/tkinter_.py
@@ -1,6 +1,6 @@
 # Example of embedding CEF Python browser using Tkinter toolkit.
 # This example has two widgets: a navigation bar and a browser.
-# Tested with Tk 8.6.
+# Tested with Tk 8.6 and CEF Python v53+.
 
 # TODO: url entry loses keyboard focus when mouse hovers over browser (#255)
 

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`# Hello world example. Doesn't depend on any third party GUI framework.`
	`2`	`+# Tested with CEF Python v53+.`
`2`	`3`
`3`	`4`	`from cefpython3 import cefpython as cef`
`4`	`5`	`import sys`