refactor: update readme file with more details

README.md

@@ -10,4 +10,12 @@ npm install -g near-cli
 
 --- check scripts in `./scripts` ---
 
+## How it works
+
+- This smart contract can be used by a delivery company to track deliveries from the warehouse to the item's destination
+- at every point the item moves, the delivery agent will need to update the current location, basically by creating a shipment with the same information and only changing the `status` and `currentLoction`
+- in the end the status will be changed to delivered and the current location will be set to the destination.
+
+
+
 

scripts/2.use-contract.sh

@@ -32,7 +32,7 @@ echo ---------------------------------------------------------
 echo
 echo
 
-near view $CONTRACT entry
+near view $CONTRACT entries
 
 echo
 echo

src/assembly/index.ts

@@ -3,11 +3,11 @@ import { MapEntry } from "near-sdk-as"
 
 export function create(shipment: string, currentLocation: string, status: string): Shipment {
 
-  return Shipment.insert(shipment, currentLocation, status);
+  return Shipment.create(shipment, currentLocation, status);
 }
 
-export function entry(): MapEntry<u32, Shipment>[] {
-  return Shipment.entry();
+export function entries(): MapEntry<u32, Shipment>[] {
+  return Shipment.entries();
 }
 
 export function get(id: u32): Shipment {

src/assembly/model.ts

@@ -16,7 +16,7 @@ export class Shipment {
     this.status = status;
   }
 
-  static insert(shipment: string, currentLocation: string, status: string): Shipment {
+  static create(shipment: string, currentLocation: string, status: string): Shipment {
     const cargo = new Shipment(shipment, currentLocation, status);
     shipments.set(cargo.id, cargo);
     return cargo;
@@ -27,7 +27,7 @@ export class Shipment {
     return cargo;
   }
 
-  static entry(): MapEntry<u32, Shipment>[] {
+  static entries(): MapEntry<u32, Shipment>[] {
     const cargos = shipments.entries()!;
     return cargos;
   }