Merge pull request #240 from kuharan/master

Update README.md

Author: dddomodossola

README.md

@@ -4,7 +4,7 @@
 </p>
 
 <p align="center" style="font-size:30px;">
-    A Platform independent Python GUI library for your applications
+    A Platform-independent Python GUI library for your applications
 </p>
 
 
@@ -29,12 +29,12 @@ instead of:
 widget.set_on_xxx_listerner(listener)
 ```
 
-And so, in order to register a listener for the *onclick* event you can do *button.onclick.connect(myapp.on_button_pressed)* .
+And so, in order to register a listener for the *onclick* event, you can do *button.onclick.connect(myapp.on_button_pressed)*.
 
 The previous dialect is still compatible.
 
 
-The parameter host_name is now deprecated. The server automatically catch the address where to connect from the http request.
+The parameter host_name is now deprecated. The server automatically catches the address where to connect from the HTTP request.
 
 
 Getting Started
@@ -69,7 +69,7 @@ Platform independent Python GUI library. In less than 100 Kbytes of source code,
     <img src="https://raw.githubusercontent.com/dddomodossola/remi/development/remi/res/screenshot.png" title="Widgets overview">
 </p>
 
-Remi enables developers to create platform independent GUI with Python. The entire GUI is converted to HTML and is rendered in your browser. **No HTML** is required, Remi automatically translates your Python code into HTML. When your app starts, it starts a webserver that will be accessible on your network.
+Remi enables developers to create platform independent GUI with Python. The entire GUI is converted to HTML and is rendered in your browser. **No HTML** is required, Remi automatically translates your Python code into HTML. When your app starts, it starts a web server that will be accessible on your network.
 
 A basic application appears like this:
 
@@ -101,32 +101,32 @@ class MyApp(App):
         self.lbl.set_text('Button pressed!')
         self.bt.set_text('Hi!')
 
-# starts the webserver
+# starts the web server
 start(MyApp)
 ```
 
 In order to see the user interface, open your preferred browser and type "http://127.0.0.1:8081".
-You can change the url address by specific **kwargs at `start` function call. This will be discussed later.
+You can change the URL address by specific **kwargs at `start` function call. This will be discussed later.
 
 Tested on Android, Linux, Windows.
-Useful on Raspberry Pi for Python script development. It allows to interact with your Raspberry Pi remotely from your mobile device.
+Useful on Raspberry Pi for Python script development. It allows interacting with your Raspberry Pi remotely from your mobile device.
 
 
 FAQ
 ===
 - **Why another GUI lib?**  
-Kivy, PyQT and PyGObject all require native code for the host operating system, which means installing or compiling large dependencies. Remi needs only a web browser to show your GUI.
+Kivy, PyQT, and PyGObject all require native code for the host operating system, which means installing or compiling large dependencies. Remi needs only a web browser to show your GUI.
 
 - **Do I need to know HTML?**  
 NO, It is not required, you have to code only in Python.
 
 - **Which browsers can I use this with?**  
-Tested on Chrome Firefox and Edge (on Windows, Linux and Android) and haven't tested it elsewhere. It will probably work fine elsewhere though!
+Tested on Chrome Firefox and Edge (on Windows, Linux, and Android) and haven't tested it elsewhere. It will probably work fine elsewhere though!
 
 - **Is it open source?**  
 For sure! Remi is released under the Apache License. See the ``LICENSE`` file for more details.
 
-- **Do I need some kind of webserver?**
+- **Do I need some kind of web server?**
 No, it's included.
 
 
@@ -143,24 +143,24 @@ Subclass the `App` class and declare a `main` function that will be the entry po
 
 ```py
 class MyApp( App ):
-	def __init__( self, *args ):
-		super( MyApp, self ).__init__( *args )
-		
-	def main( self ):
-		lbl = gui.Label( "Hello world!", width=100, height=30 )
-		
-		#return of the root widget
-		return lbl
+    def __init__( self, *args ):
+        super( MyApp, self ).__init__( *args )
+        
+    def main( self ):
+        lbl = gui.Label( "Hello world!", width=100, height=30 )
+        
+        #return of the root widget
+        return lbl
 ```
 
 Outside the main class start the application calling the function `start` passing as parameter the name of the class you declared previously.
 
 ```py
-#starts the webserver	
+#starts the webserver    
 start( MyApp )
 ```
 
-Run the script. If all it's OK the gui will be opened automatically in your browser, otherwise you have to type in the address bar "http://127.0.0.1:8081".
+Run the script. If all it's OK the GUI will be opened automatically in your browser, otherwise, you have to type in the address bar "http://127.0.0.1:8081".
 
 You can customize optional parameters in the `start` call like.
 
@@ -169,29 +169,29 @@ start(MyApp,address='127.0.0.1', port=8081, multiple_instance=False, enable_file
 ```
 
 Parameters:
-- address: network interface ip
+- address: network interface IP
 - port: listen port
-- multiple_instance: boolean, if True multiple clients that connects to your script has different App instances (identified by unique cookie session identifier)
+- multiple_instance: boolean, if True multiple clients that connect to your script has different App instances (identified by unique cookie session identifier)
 - enable_file_cache: boolean, if True enable resource caching
-- update_interval: gui update interval in seconds. If zero, the update happens at each change. If zero, the App.idle method is not called. 
+- update_interval: GUI update interval in seconds. If zero, the update happens at each change. If zero, the App.idle method is not called. 
 - start_browser: boolean that defines if the browser should be opened automatically at startup
-- standalone: boolean, indicates where to run the application as standard Desktop application with its own window. If False, the interface is shown in a browser webpage.
+- standalone: boolean, indicates where to run the application as a standard Desktop application with its own window. If False, the interface is shown in a browser webpage.
 
 Additional Parameters:
-- username: for a basic http authentication
-- password: for a basic http authentication
-- certfile: ssl certificate filename
-- keyfile: ssl key file
-- ssl_version: authentication version (i.e. ssl.PROTOCOL_TLSv1_2). If None, disables ssl encription
+- username: for a basic HTTP authentication
+- password: for a basic HTTP authentication
+- certfile: SSL certificate filename
+- keyfile: SSL key file
+- ssl_version: authentication version (i.e. ssl.PROTOCOL_TLSv1_2). If None disables SSL encryption
 
-All widgets constructors accepts two standard **kwargs that are:
-- width: can be expressed as int (and is interpreted as pixel) or as str (and you can specify the measure unit like '10%')
-- height: can be expressed as int (and is interpreted as pixel) or as str (and you can specify the measure unit like '10%')
+All widgets constructors accept two standards**kwargs that are:
+- width: can be expressed as int (and is interpreted as a pixel) or as str (and you can specify the measuring unit like '10%')
+- height: can be expressed as int (and is interpreted as a pixel) or as str (and you can specify the measuring unit like '10%')
 
 
 Events and callbacks
 ===
-Widgets exposes a set of events that happens during user interaction. 
+Widgets expose a set of events that happen during user interaction. 
 Such events are a convenient way to define the application behavior.
 Each widget has its own callbacks, depending on the type of user interaction it allows.
 The specific callbacks for the widgets will be illustrated later.
@@ -227,7 +227,7 @@ class MyApp(App):
         self.lbl.set_text('Button pressed!')
         self.bt.set_text('Hi!')
 
-# starts the webserver
+# starts the web server
 start(MyApp)
 ```
 
@@ -237,7 +237,7 @@ Simple, easy.
 Listener's callbacks will receive the emitter's instance firstly, then all other parameters provided by the specific event.
 
 
-Beside the standard event registration (as aforementioned), it is possible to pass user parameters to listener functions. This can be achieves appending parameters to the *connect* function call.
+Besides the standard event registration (as aforementioned), it is possible to pass user parameters to listener functions. This can be achieves appending parameters to the *connect* function call.
 
 ```py
 import remi.gui as gui
@@ -270,26 +270,26 @@ class MyApp(App):
         self.lbl.set_text('Button pressed!')
         widget.set_text('Hello ' + name + ' ' + surname)
 
-# starts the webserver
+# starts the web server
 start(MyApp)
 ```
 
-This allows great flexibility, getting different behaviours with the same event listener definition.
+This allows great flexibility, getting different behaviors with the same event listener definition.
 
 
 HTML Attribute accessibility
 ===
-Sometimes could be required to access Widget's HTML representation in order to manipulate html attributes.
-The library allows to access these information easily.
+Sometimes could be required to access Widget's HTML representation in order to manipulate HTML attributes.
+The library allows accessing this information easily.
 
-A simple example: It is the case where you would like to add an hover text to a widget. This can be achieved by the *title* attribute of an html tag.
+A simple example: It is the case where you would like to add a hover text to a widget. This can be achieved by the *title* attribute of an HTML tag.
 In order to do this:
 
 ```py
     widget_instance.attributes['title'] = 'Your title content'
 ```
 
-A special case of html attribute is the *style*.
+A special case of HTML attribute is the *style*.
 The style attributes can be altered in this way:
 
 ```py
@@ -298,9 +298,9 @@ The style attributes can be altered in this way:
 
 The assignment of a new attribute automatically creates it.
 
-For a reference list of html attributes you can refer to https://www.w3schools.com/tags/ref_attributes.asp
+For a reference list of HTML attributes, you can refer to https://www.w3schools.com/tags/ref_attributes.asp
 
-For a reference list of style attributes you can refer to https://www.w3schools.com/cssref/default.asp
+For a reference list of style attributes, you can refer to https://www.w3schools.com/cssref/default.asp
 
 Take care about internally used attributes. These are:
 - **class**: It is used to store the Widget class name for styling purpose
@@ -310,7 +310,7 @@ Take care about internally used attributes. These are:
 Remote access
 ===
 If you are using your REMI app remotely, with a DNS and behind a firewall, you can specify special parameters in the `start` call:
-- **port**: http server port. Don't forget to NAT this port on your router;
+- **port**: HTTP server port. Don't forget to NAT this port on your router;
 
 ```py
 start(MyApp, address='0.0.0.0', port=8081) 
@@ -319,18 +319,18 @@ start(MyApp, address='0.0.0.0', port=8081)
 
 Standalone Execution
 ===
-I suggest to use the browser as standard interface window.
+I suggest using the browser as a standard interface window.
 
 However, you can avoid using the browser.
 This can be simply obtained joining REMI and [PyWebView](https://github.com/r0x0r/pywebview). 
 Here is an example about this [standalone_app.py](https://github.com/dddomodossola/remi/blob/development/examples/standalone_app.py).
 
-**Be aware that PyWebView uses qt, gtk and so on to create the window. An outdated version of these libraries can cause ui problems. If you experience ui issues, update these libraries, or better avoid standalone execution.**
+**Be aware that PyWebView uses qt, gtk and so on to create the window. An outdated version of these libraries can cause UI problems. If you experience UI issues, update these libraries, or better avoid standalone execution.**
 
 
 Authentication
 ===
-In order to limit the remote access to your interface you can define a username and password. It consists in a simple authentication process.
+In order to limit the remote access to your interface, you can define a username and password. It consists of a simple authentication process.
 Just define the parameters **username** and **password** in the start call:
 ```py
 start(MyApp, username='myusername', password='mypassword') 
@@ -339,7 +339,7 @@ start(MyApp, username='myusername', password='mypassword')
 
 Styling
 ===
-In order to define a new style for your app you have to do the following.
+In order to define a new style for your app, you have to do the following.
 Create a *res* folder and pass it to your App class constructor:
 ```python
 class MyApp(App):
@@ -354,12 +354,12 @@ This way the standard *style.css* file gets overridden by the one you created.
 
 Compatibility
 ===
-Remi is made to be compatible from Python2.7 to Python3.X . Please notify compatibility issues.
+Remi is made to be compatible from Python2.7 to Python3.X. Please notify compatibility issues.
 
 
 Security
 ===
-Remi should be intended as a standard desktop gui framework. 
+Remi should be intended as a standard desktop GUI framework. 
 The library itself doesn't implement security strategies, and so it is advised to not expose its access to unsafe public networks.
 
 When loading data from external sources, consider protecting the application from potential javascript injection before displaying the content directly.
@@ -374,14 +374,15 @@ That's a brilliant way to support this project.
 
 **[SUPPORT Remi now](https://patreon.com/remigui)**
 
-Also a small amount is really welcome.
+Also, a small amount is really welcome.
 
 
 Contributors
 ===
 Thank you for collaborating with us to make Remi better!
-The real power of opensource are contributors. Please feel free to participate to this project, and consider to add yourself to the following list.
-Yes I know that github already provides a list of contributors, but I feel that I must mention who helps.
+
+The real power of opensource is contributors. Please feel free to participate in this project, and consider to add yourself to the following list.
+Yes, I know that GitHub already provides a list of contributors, but I feel that I must mention who helps.
 
 [Davide Rosa](https://github.com/dddomodossola)