diff --git a/README.md b/README.md index 7c48789646..bbcbb742ec 100644 --- a/README.md +++ b/README.md @@ -15,14 +15,15 @@ This repo is constructed using yarn workspaces and consists of the 4 sections: You will need -- Node (>=18): https://nodejs.org/en/download/ +- Node (>=21): https://nodejs.org/en/download/ - Yarn (v1.22.5 or newer): https://classic.yarnpkg.com/en/docs/install ## Build the extension -To simply build a production version of the extension, install the prerequisites then navigate to this root folder in your command line and run these 2 steps: +To simply build a production version of the extension, install the prerequisites then navigate to this root folder (`/freighter`) in your command line and run these 2 steps: ``` +yarn install yarn setup ``` @@ -47,7 +48,7 @@ This will start up multiple watching builds in parallel: - The docs, serving on `localhost:3000` - A dev server with the webapp running in the extension, serving on `localhost:9000` -- The actual built extension, able to be installed in Chrome, in `build/` +- The actual built extension, able to be installed in Chrome or Firefox, in `build/` Each of these will build in response to editing their source. @@ -70,12 +71,21 @@ an individual workspace. ### Useful URLs: +[Configure the backend](https://github.com/stellar/freighter/blob/master/extension/README.md#configure-the-backend) + +[Build the extension and install it on your machine](https://github.com/stellar/freighter/blob/master/extension/README.md#build-the-extension-and-install-it-on-your-machine) + [The popup webapp](http://localhost:9000/#/) -[The `getPublicKey` playground](http://localhost:3000/docs/playground/getPublicKey) +[The `setAllowed` playground](http://localhost:3000/docs/playground/setAllowed) + +[The `requestAccess` playground](http://localhost:3000/docs/playground/requestAccess) + +[The `getAddress` playground](http://localhost:3000/docs/playground/getAddress) + [The `signTransaction` playground](http://localhost:3000/docs/playground/signTransaction) -It's important to note that these two won't interact with the _dev server_ popup +It's important to note that these last functions won't interact with the _dev server_ popup UI on `localhost:9000` — you'll need to re-install the unpacked extension each time you make a change. diff --git a/docs/docs/guide/developingForSoroban.md b/docs/docs/guide/developingForSoroban.md index b6d7606c30..21046b74e5 100644 --- a/docs/docs/guide/developingForSoroban.md +++ b/docs/docs/guide/developingForSoroban.md @@ -36,7 +36,7 @@ import { /* For this example, we are assuming the token adheres to the interface documented in SEP-0041 */ const generateTransferXdr = (contractId, serverUrl, publicKey, destination, amount, fee, networkPassphrase, memo) => { - // the contract id of the the token + // the contract id of the token const contract = new Contract(contractId); const server = new SorobanRpc.Server(serverUrl); diff --git a/docs/docs/guide/gettingStarted.md b/docs/docs/guide/gettingStarted.md index 9fa71d0fe4..1ddb423ba2 100644 --- a/docs/docs/guide/gettingStarted.md +++ b/docs/docs/guide/gettingStarted.md @@ -26,7 +26,7 @@ or #### For browser-based applications -- Install the packaged library via script tag using cdnjs, swapping in the desired version number for `{version}`: +- Install the packaged library via `script` tag using cdnjs, swapping in the [desired version number](https://www.npmjs.com/package/@stellar/freighter-api?activeTab=versions) for `{version}`: _NOTE:_ You must use version `1.1.2` or above diff --git a/docs/docs/guide/signXdr.md b/docs/docs/guide/signXdr.md index bd71b0c187..fff0de215e 100644 --- a/docs/docs/guide/signXdr.md +++ b/docs/docs/guide/signXdr.md @@ -15,6 +15,6 @@ You can serialize an assembled transaction to a base64 encoded xdr string using During the transaction/operation review, you can review signing details at different fidelities. -- Summary: The first tab is the summary tab which lays out high level trasnsction/operation details. +- Summary: The first tab is the summary tab which lays out high level transaction/operation details. - Operation Details: The second tab exposes information about the operations in the transaction and optionally walks through the invocation chain and highlights authorizations. - Raw XDR: The last tab lets you copy the raw XDR to be used outside of Freighter. diff --git a/docs/docs/guide/usingFreighterBrowser.mdx b/docs/docs/guide/usingFreighterBrowser.mdx index 7ba4c4bfdc..ed48896ddd 100644 --- a/docs/docs/guide/usingFreighterBrowser.mdx +++ b/docs/docs/guide/usingFreighterBrowser.mdx @@ -11,14 +11,12 @@ We now have an extension installed on our machine and a library to interact with First import the library in the `
` tag of your page. -- Install the packaged library via script tag using cdnjs, swapping in the desired version number for `{version}` - -_NOTE:_ You must use version `1.1.2` or above - -For example, include the `script` in your `head` tag using the following code: +Install the packaged library via `script` tag using cdnjs. For example, use the following code to install the [latest freighter api version](https://www.npmjs.com/package/@stellar/freighter-api?activeTab=versions):