update README.md

README.md

@@ -1,2 +1,43 @@
-# Challenge 1 - Text encryption tool
-This is my solution for the Challenge 1 in the Alura ONE G7 program.
+# bracamontesman's cipher tool
+
+bracamontesman's cipher tool is a simple web application that allows users to encrypt and decrypt text using a basic cipher algorithm. the tool is designed to be easy to use and is fully responsive, working seamlessly on both desktop and mobile devices.
+
+## features
+
+- **text encryption:** encrypt any text using a predefined cipher algorithm.
+- **text decryption:** decrypt previously encrypted text back to its original form.
+- **copy to clipboard:** quickly copy the encrypted or decrypted text with a single click.
+- **reset functionality:** clicking the logo clears the input text and resets the page.
+
+## usage
+
+1. **enter your text:** type or paste the text you want to encrypt or decrypt into the input area.
+2. **choose an action:** click the "encrypt" or "decrypt" button to perform the desired action.
+3. **view the result:** the encrypted or decrypted text will be displayed in the result area.
+4. **copy the result:** use the "copy text" button to copy the result to your clipboard.
+5. **reset:** click the logo to clear the input text and reset the page.
+
+## project structure
+
+- `index.html`: contains the html structure of the application.
+- `style.css`: contains the styles for the application, including responsive design and button states.
+- `cipher.js`: contains the javascript logic for encryption, decryption, copying text, and resetting the page.
+
+## customization
+
+you can easily customize the tool by modifying the following files:
+
+- **styles:** update the `style.css` file to change the look and feel of the tool.
+- **encryption/decryption logic:** modify the `cipher.js` file if you want to use a different encryption algorithm.
+
+## dependencies
+
+this project does not require any external libraries or dependencies. it runs entirely in the browser using html, css, and javascript.
+
+## license
+
+this project is open source and available under the [mit license](LICENSE).
+
+## acknowledgements
+
+this tool was developed as part of the alura one oracle next education program.