From c8e3a4e48cb331b986734dfe07128f89fd4a357c Mon Sep 17 00:00:00 2001
From: Arthur <arthur@coeos.xyz>
Date: Mon, 7 Aug 2023 13:36:48 +0200
Subject: [PATCH] Update README.md instruction (#26)

---
 README.md | 34 +++++++++-------------------------
 1 file changed, 9 insertions(+), 25 deletions(-)

diff --git a/README.md b/README.md
index 0e8f276..1fc0305 100644
--- a/README.md
+++ b/README.md
@@ -59,46 +59,30 @@ Description of the fields:
 | symbol | Token symbol e.g. UNI | string | Mandatory |
 | decimals | Allowed number of decimals for the listed token | integer | Mandatory |
 | createdAt | Date and time token was created | string | Mandatory |
-| updateAt | Date and time token was updated | string | Mandatory |
+| updateAt | Date and time token was last updated | string | Mandatory |
 | logoURI | URI or URL of the token logo following the RFC 3986 standard | string | Optional |
 | extension | Extension to specify information about the token on its native chain if it was bridged | Array | Mandatory if the token has been bridged, otherwise optional |
 | rootChainId | The typically used number identifier for the chain on which the token was originally issued | number | Mandatory if the token has been bridged, otherwise optional |
 | rootChainURI | A resolvable URI to the genesis block of the root chain on which the token was originally issued following the RFC 3986 standard | string | Mandatory if the token has been bridged, otherwise optional |
 | rootAddress | Address of the token on its native chain | string | Mandatory if the token has been bridged, otherwise optional |
 
-<b>Note</b>: please ensure the completed JSON follows the schema outlined in [./json/schema/l2-token-list-schema.json](./json/schema/l2-token-list-schema.json). Make sure to add the token following alphabetical order of the `symbol` field.
-
+<b>Additional guidelines</b>:
+* Please ensure the completed JSON follows the schema outlined in [./json/schema/l2-token-list-schema.json](./json/schema/l2-token-list-schema.json).
+* Make sure to add the token following alphabetical order of the `symbol` field.
+* Update the `updatedAt` (and potentially `createdAt`) fields for the file and the token
+* Update the file version:
+    * Increase `patch` when modifying information of an existing token
+    * Increase `minor` when modifying adding a new token
+    * Increase `major` when changing the structure of the file
 
 3. Commit your changes and push your branch.
 
 <b>Note</b>: Only commit the list file. Do not modify the schema or the templates.
 
-
 4. Go to https://github.com/ConsenSys/linea-token-list/pulls and create a new PR. Make sure to set the base branch as `main`.
 
 A GitHub Actions workflow will automatically verify the integrity of your JSON. If the check passes, validators will review the new list. If all the information are correct, they will approve the token addition.
 
 In case of a failing check, refer to the error message in the [Actions](https://github.com/ConsenSys/linea-token-list/actions) tab. Make necessary modifications and try again.
 
-## How to validate the new Token (for validators)
-
-As a validator, you should:
-
-1. Copy the JSON version template from [./json/templates/linea-goerli-token-version-template.json](./json/templates/linea-goerli-token-version-template.json).
-2. Fill out the copied template with the new version's information.
-3. Add the completed JSON to the versions array in [./json/linea-goerli-token-shortlist.json](./json/linea-goerli-token-shortlist.json).
-
-Example:
-
-```
-{
-  [...]
-  "versions": [
-    // Append the JSON here
-  ]
-}
-```
-
-4. Commit the changes and approve the PR.
-
 Happy contributing!