From a7cc65c862cc309ac4908e5ad932f5b581430471 Mon Sep 17 00:00:00 2001 From: Bros G <106735266+BrosG@users.noreply.github.com> Date: Mon, 22 May 2023 21:30:53 +0100 Subject: [PATCH] Update README.md Better is better --- README.md | 40 +++++++++++++++++++++++++++++++++------- 1 file changed, 33 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index c337b134e..9addd9e7d 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,40 @@ - +# SaTT Wallet ๐Ÿš€๐Ÿ’ผ -## SaTT Wallet API +Welcome to SaTT Wallet, a cutting-edge project in the realm of smart advertising. Our wallet leverages blockchain technology to offer a unique approach to managing and transacting with the Smart Advertising Transaction Token (SaTT). ๐ŸŒ๐Ÿ’ฐ -Welcome to SaTT Webservice endpoint, this backend provides webservice to SaTT WebWallet and advertising campaign manager : [Wallet](https://dapp.satt.com/) +## Project Overview ๐Ÿ“š -It provides : +Our project is composed of two main repositories: -- Masterseed HD Wallet management for SaTT and other main cryptos. -- Transaction management -- Advertising campaign management +1. **Backend** ๐Ÿ–ฅ๏ธ: This part of the project provides the webservice for the SaTT Token WebWallet and the advertising campaign manager. It's primarily written in JavaScript. + +2. **Frontend** ๐ŸŽจ: The frontend of the SaTT wallet is built using Angular, a robust framework in the TypeScript ecosystem. + +## How to Contribute ๐Ÿ’ช๐Ÿ”ง + +We welcome developers who are passionate about decentralized technology, advertising, and improving user experience. + +To contribute: + +1. Fork the repository you wish to contribute to (Backend or Frontend). ๐Ÿด +2. Create a new branch for your feature. ๐ŸŒฟ +3. Make your changes and commit them with clear, concise messages. ๐Ÿ“ +4. Push your changes to your branch. ๐Ÿš€ +5. Create a pull request. ๐Ÿ™ + +We strongly encourage contributors to adhere to best coding practices, which include: + +- Write clean, readable, and maintainable code. ๐Ÿงนโœจ +- Use meaningful naming for variables, functions, classes, and modules. ๐Ÿท๏ธ +- Comment your code where necessary but strive to make your code as self-explanatory as possible. ๐Ÿ—‚๏ธ +- Avoid large commits that make the code review process more difficult. Break your work into small, individual commits each with a specific purpose. ๐Ÿงฉ +- Update and write tests when contributing to code. ๐Ÿงช + +## Get in Touch ๐Ÿ“ž๐Ÿ“ง + +If you have any questions or suggestions, please reach out to us at contact@satt-token.com. You can also follow our updates on Twitter at [@SaTT_Token](https://twitter.com/SaTT_Token). + +Happy coding! ๐ŸŽ‰๐Ÿ‘ฉโ€๐Ÿ’ป๐Ÿ‘จโ€๐Ÿ’ป ### Built With