Base PR to include ts-doc in sdk library sources (#15)

* add typedoc comments

* documentation.md was removed because typedoc is now used

* running typedoc

* removed docs

* added docs into gitignore

* irrelevant subtitle removed

.gitignore

@@ -2,3 +2,4 @@
 .DS_Store
 node_modules
 dist
+docs

README.md

@@ -10,28 +10,11 @@ You can install Alex-SDK using npm:
 npm install alex-sdk
 ```
 
-## Functions
+## Documentation
 
-The AlexSDK class includes the following functions:
+For detailed API documentation, including a full list of available methods and their usage, please refer to:
 
-```typescript
-export declare class AlexSDK {
-  fetchSwappableCurrency(): Promise<TokenInfo[]>;
-  getAllPossibleRoutes(from: Currency, to: Currency): Promise<AMMRoute[]>;   
-  getAmountTo(from: Currency, fromAmount: bigint, to: Currency): Promise<bigint>;
-  getBalances(stxAddress: string): Promise<Partial<{ [currency in Currency]: bigint }>>;
-  getFeeRate(from: Currency, to: Currency): Promise<bigint>;
-  getLatestPrices(): Promise<Partial<{ [currency in Currency]: number }>>;
-  getRoute(from: Currency, to: Currency): Promise<AMMRoute>;
-  getRouter(from: Currency, to: Currency): Promise<Currency[]>; // deprecated
-  getWayPoints(route: AMMRoute): Promise<TokenInfo[]>;
-  runSwap(stxAddress: string, currencyX: Currency, 
-          currencyY: Currency, fromAmount: bigint, 
-          minDy: bigint, customRoute: AMMRoute): Promise<TxToBroadCast>;
-}
-```
-
-(detailed list [here](./documentation.md)).
+[SDK API Documentation](/alex-sdk/).
 
 ## Usage
 

package.json

@@ -21,6 +21,8 @@
     "lint-fix": "dts lint --fix",
     "size": "size-limit",
     "gen:contract": "rm -rf src/generated/smartContract/* && tsx ./scripts/gen-contract.ts && prettier --write 'src/generated/smartContract'",
+    "docs": "typedoc src/index.ts",
+    "docs:watch": "typedoc src/index.ts --watch",
     "analyze": "size-limit --why",
     "ci": "pnpm run lint && pnpm run test && pnpm run size"
   },
@@ -72,6 +74,7 @@
     "ts-json-schema-generator": "^2.3.0",
     "tslib": "^2.6.3",
     "tsx": "^4.15.5",
+    "typedoc": "^0.26.6",
     "typescript": "^5.4.5"
   }
 }