README_Token.md

README_TEMPLATE.md

@@ -1,41 +1,78 @@
-# Project Title
+## TOKEN
 
-Simple overview of use/purpose.
+Token programming is a coding technique where a program is broken down into its smallest building blocks, called tokens. These tokens represent individual elements like keywords, variables, and operators in a programming language
 
 ## Description
 
-An in-depth paragraph about your project and overview of use.
+Token programming involves working with the smallest units of code, called tokens, to perform various tasks like code generation, refactoring, analysis, and more. It allows developers to manipulate these tokens to achieve specific goals in software development, making it a versatile technique for improving code quality, automating tasks, and building dynamic solutions.
 
-## Getting Started
 
-### Installing
+### Executing program
 
-* How/where to download your program
-* Any modifications needed to be made to files/folders
+To run this program, you can use Remix, an online Solidity IDE. To get started, go to the Remix website at https://remix.ethereum.org/.
 
-### Executing program
+Once you are on the Remix website, create a new file by clicking on the "+" icon in the left-hand sidebar. Save the file with a .sol extension (e.g., HelloWorld.sol). Copy and paste the following code into the file:
+
+// SPDX-License-Identifier: MIT
+pragma solidity 0.8.18;
+
+/*
+       REQUIREMENTS
+    1. Your contract will have public variables that store the details about your coin (Token Name, Token Abbrv., Total Supply)
+    2. Your contract will have a mapping of addresses to balances (address => uint)
+    3. You will have a mint function that takes two parameters: an address and a value. 
+       The function then increases the total supply by that number and increases the balance 
+       of the “sender” address by that amount
+    4. Your contract will have a burn function, which works the opposite of the mint function, as it will destroy tokens. 
+       It will take an address and value just like the mint functions. It will then deduct the value from the total supply 
+       and from the balance of the “sender”.
+    5. Lastly, your burn function should have conditionals to make sure the balance of "sender" is greater than or equal 
+       to the amount that is supposed to be burned.
+*/
+
+contract MyToken {
+
+
+
+    // public variables here
+
+string public TokenName = "Shelby";
+string public TokkenAbv = "MTV";
+uint public totalSupply = 0;
+    // mapping variable here
+
+    mapping(address => uint) public balances;
+
+    // mint function
+
+    function mint(address _address, uint _value) public{
+    totalSupply += _value;
+    balances[_address] += _value;
+
+    }
+
+    // burn function
+     function burn(address _address, uint _value) public{
+    if(balances[_address] >= _value){
+    totalSupply -= _value;
+    balances[_address] -= _value;
+     }
+}
+}
 
-* How to run the program
-* Step-by-step bullets
-```
-code blocks for commands
-```
+To compile the code, click on the "Solidity Compiler" tab in the left-hand sidebar. Make sure the "Compiler" option is set to "0.8.18" (or another compatible version), and then click on the "Tok.sol" button.
 
-## Help
+Once the code is compiled, you can deploy the contract by clicking on the "Deploy & Run Transactions" tab in the left-hand sidebar. Select the "MyTok" contract from the dropdown menu, and then click on the "Deploy" button.
 
-Any advise for common problems or issues.
-```
-command to run if program contains helper info
-```
+Once the contract is deployed, you can interact with it by calling the sayHello function. Click on the "MyToken" contract in the left-hand sidebar, and then click on the "mint" function. Finally, click on the "transact" button to execute the function and retrieve the "MyToken!" message.
 
 ## Authors
 
-Contributors names and contact info
 
-ex. Dominique Pizzie  
-ex. [@DomPizzie](https://twitter.com/dompizzie)
+Dioshua Sapnu
+@dioshuadalugdugan@gmail.com
 
 
 ## License
 
-This project is licensed under the [NAME HERE] License - see the LICENSE.md file for details
+This project is licensed under the MIT License - see the LICENSE.md file for details