Update README.md

README.md

@@ -1,38 +1,64 @@
-Role Name
-=========
+# Ansible Role: bash
 
-A brief description of the role goes here.
+This role installs a customized Bash environment on your remote servers. It includes configuration files, aliases, and scripts to enhance your command-line experience.
 
-Requirements
-------------
+## Requirements
 
-Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required.
+This role was tested on Debian-based systems, and may require adaptations for other Linux distributions.
 
-Role Variables
---------------
+## Role Variables
 
-A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well.
+The following variables can be customized when using this role:
 
-Dependencies
-------------
+### `bash_users`
 
-A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles.
+This variable defines a list of users for whom the Bash environment will be installed and configured. By default, the list is empty. 
 
-Example Playbook
-----------------
+**Default Value:** `[]`
 
-Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
+**Example:**
+```yaml
+bash_users:
+  - alice
+  - bob
+```
 
-    - hosts: servers
-      roles:
-         - { role: username.rolename, x: 42 }
+This would install the customized Bash environment for users `alice` and `bob`.
 
-License
--------
+## Dependencies
 
-BSD
+This role has no dependencies on other Ansible Galaxy roles.
 
-Author Information
-------------------
+## Example Playbook
 
-An optional section for the role authors to include contact information, or a website (HTML is not allowed).
+This example playbook demonstrates how to use the `glenux.bash` role.
+
+```yaml
+- hosts: servers
+  become: true
+  roles:
+    - role: glenux.bash
+      vars:
+        bash_users:
+          - user1
+          - user2
+```
+
+This playbook will install the custom Bash environment on all servers in the `servers` group for users `user1` and `user2`.
+
+## Details
+
+Here is a brief overview of the role's structure:
+
+- **Configuration Files:** The role installs customized Bash configuration files like `.bashrc`, `.bash_profile` and `.bash_aliases` to the home directories of specified users.
+- **bashrc.d Directory:**  A `.bashrc.d` directory is created to store modular Bash scripts that are sourced by the main `.bashrc` file. This allows for organized customization and separation of concerns.
+- **Aliases:**  A set of useful aliases for common commands is included in the `.bash_aliases` file.
+- **Development Environments:** Support for various development environments such as Android, Go, and Ruby is included through scripts within the `.bashrc.d` directory. You can adjust these scripts or add new ones based on your specific needs.
+
+## License
+
+GPLv2
+
+## Author Information
+
+This role was created by [Your Name] You can reach out for any questions or feedback.