Skip to content

Commit b346a23

Browse files
committed
Add instructions to README about setup through downloading a release
1 parent 9384ca2 commit b346a23

File tree

1 file changed

+31
-10
lines changed

1 file changed

+31
-10
lines changed

README.md

Lines changed: 31 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,46 @@
44
A custom new-tab page.
55
```
66

7-
Minimalistic, cool, lightweight. Integrated with the
8-
TransferWise API to show your current borderless account balance.
7+
Minimalistic, cool, lightweight. Integrated with the TransferWise API to show your current borderless account balance.
98

109
![example](https://user-images.githubusercontent.com/21343173/93712115-7c045880-fb4b-11ea-9471-b0832309251c.png)
1110

1211
## How to use
1312

13+
**Prerequisites**: you need
14+
to [generate a TransferWise Personal API token](https://api-docs.transferwise.com/payouts#wise-payouts-api-documentation-api-access)
15+
to use this page's integration with TransferWise balances.
16+
17+
### Download a release
18+
19+
Changes are automatically built and pushed to the [GitHub Releases](https://github.com/StenAL/new-tab/releases) page
20+
where you can find ready-to-use artifacts in `.zip` and `.tar.gz` format. To set up the page:
21+
22+
1. Download the artifact in your preferred format (either through GitHub's GUI or using the command line)
23+
`curl -L -O "https://github.com/StenAL/new-tab/releases/latest/download/new-tab.tar.gz"`
24+
2. Extract files from the archive (through a GUI like 7zip or using the command line)
25+
`tar -xvf new-tab.tar.gz`
26+
3. Set the TransferWise API token to your personal access token instead of the placeholder (either
27+
open `build/static/js/main.RANDOM-LETTERS-AND-NUMBERS.js`, CTRL+F for "TOKEN-GOES-HERE" and replace it with your
28+
token or use the command line)
29+
`sed -i 's/TOKEN-GOES-HERE/YOUR-ACTUAL-TOKEN/g' build/static/js/main.*.js`
30+
4. The page can now be accessed at `build/index.html`
31+
32+
### Build locally
33+
1434
1. Clone the git repository `git clone https://github.com/StenAL/favicon-marquee.git`
1535
2. Install dependencies using npm `npm i`
16-
3. [Generate a TransferWise API token](https://transferwise.com/help/19/transferwise-for-business/2958229/whats-a-personal-api-token-and-how-do-i-get-one)
17-
4. Create a `.env` file at the root directory of your project and specify your
18-
token in it `REACT_APP_TRANSFERWISE_API_TOKEN=token-goes-here`. This token
19-
is only used for API calls and is never stored anywhere except your `.env` and `build` files
20-
5. Build the final static resources `npm run build`
36+
3. Create a `.env` file at the root directory of your project and set your API token in
37+
it: `REACT_APP_TRANSFERWISE_API_TOKEN=token-goes-here`.
38+
This token is only used for API calls and is never stored anywhere except your `.env` and `build` files
39+
4. Build the static page `npm run build`
2140

22-
Your new-tab page is now ready. It is available at `build/index.html`
41+
Your `new-tab` is now ready. It is available at `build/index.html`
2342

24-
Depending on your browser you now need to either manually redirect your new-tab page ([Firefox](https://reddit.com/r/firefox/comments/ge86z4/newtab_page_to_local_file_firefox_76_redux/fqpyahl/))
25-
or use an extension to do it ([Chrome](https://chrome.google.com/webstore/detail/new-tab-redirect/icpgjfneehieebagbmdbhnlpiopdcmna)).
43+
Depending on your browser you now need to either manually redirect your new-tab
44+
page ([Firefox](https://reddit.com/r/firefox/comments/ge86z4/newtab_page_to_local_file_firefox_76_redux/fqpyahl/))
45+
or use an extension to do
46+
it ([Chrome](https://chrome.google.com/webstore/detail/new-tab-redirect/icpgjfneehieebagbmdbhnlpiopdcmna)).
2647

2748
## License
2849

0 commit comments

Comments
 (0)