Update README

Author: FlyersWeb

LICENSE

@@ -1,11 +1,13 @@
-Copyright (c) 2004-2013 Fabien Potencier
+MIT License
+
+Copyright (c) 2020 Nassim Ben Ghmiss
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights
 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is furnished
-to do so, subject to the following conditions:
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.
@@ -15,5 +17,5 @@ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,46 +1,53 @@
 angular-symfony
 ===============
 
-Project Bootstrap for an angularJS + Symfony webservices project.
+Project Bootstrap for an Angular 2+ and Symfony 4+ webservices project.
 
 Introduction
 ------------
 
-This project is a template application with secured communication via a RestFul API between the client part with AngularJS and the server part with Symfony2.
+This project is a template application with a secured RestFul API communication via WSS UserToken security scheme.
+
+Buy me a coffee
+---------------
+
+[![Buy me a coffee](https://raw.githubusercontent.com/FlyersWeb/angular-symfony/upgrade/buy-me-a-coffee.png)](https://paypal.me/nac1dbois)
+
+I'm working on this project in my free time and offering it free of charges. To help me work more on this you can help me by sending me a tip.
 
 Installation
 ------------
 
-Install docker and docker-compose, refer to docker documentation.
+Install docker and docker-compose.
 
 Clone the project :
 
-  git clone [email protected]:FlyersWeb/angular-symfony.git angular-symfony
+	git clone [email protected]:FlyersWeb/angular-symfony.git
 
 Launch dockerized environment :
 
-  docker-compose up -d
+	docker-compose up -d
 
 Log in application docker image :
 
-  docker-compose exec application bash
+	docker-compose exec application bash
 
 Update schemas (FOSUserBundle) :
 
-  php bin/console doctrine:schema:create
+	php bin/console doctrine:schema:create
 
 Create and activate user :
 
-  php bin/console doctrine:fixtures:load
+	php bin/console doctrine:fixtures:load
 
 Access the front end using port 4200 :
 
-  firefox http://localhost:4200 &
+	firefox http://localhost:4200 &
 
 Authentication system
 ---------------------
 
-The Authentication system is based on the custom Authentication Provider of the Symfony2 Cookbook : http://symfony.com/doc/2.1/cookbook/security/custom_authentication_provider.html
+The Authentication system is based on the custom Authentication Provider of the [Symfony Cookbook](https://symfony.com/doc/4.4/security/custom_authentication_provider.html)
 
 > The following chapter demonstrates how to create a custom authentication provider for WSSE authentication. The security protocol for WSSE provides several security benefits:
 > * Username / Password encryption
@@ -49,14 +56,26 @@ The Authentication system is based on the custom Authentication Provider of the
 >
 > WSSE is very useful for the securing of web services, may they be SOAP or REST.
 
-I used the exact same authentication system with a little change in moment of generating the digest, we use the hexadecimal value of the hashed seed in lieu of the binary value.
+I used the exact same authentication system.
 
 Client Side specifics
 ---------------------
 
-On the client side, I've inspired my code from Nils Blum-Oeste article explaining how to send an authorization token for every request. To do this you have to register a wrapper for every resource actions that execute a specific code before doing the action. For more information you can check http://nils-blum-oeste.net/angularjs-send-auth-token-with-every--request/.
+On the client side, I've inspired my code from Angular official documentation about HttpInterceptor, allowing me to send the WSS UserToken on each HTTP request when token is available. Examples usually shows how to send the Authorization header.
+
+The difference there is that I send the token, username and user digest in the HTTP Header *X-WSSE*.
+
+LICENSE
+-------
+
+This program is free software. It comes without any warranty, to the extent permitted by applicable law.
+
+This software is LICENSED under the MIT License. Use it at your own risk.
+
+WARNING
+-------
 
-The differences there is that I send the token, username and user digest in the HTTP Header *X-WSSE*.
+Servers are configured for developments purposes. Do not deploy this project on production as is. You should have a look to [Symfony deployment documentation](https://symfony.com/doc/4.4/deployment.html) for the Back-end and the [Angular deployment documentation](https://angular.io/guide/deployment) for the Front-End part.
 
 Conclusion
 ----------