diff --git a/README.md b/README.md index 4cb3ffd..652c7c5 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -# Up Bank Transaction Tagger +# Unofficial Up Bank Web App -Web app using [Up Bank API](https://developer.up.com.au/) to allow bulk tagging of -transactions. Everything happens in your browser, so a refresh will wipe any loaded -transactions. +Web app using [Up Bank API](https://developer.up.com.au/), currently primarily to +allow bulk tagging of transactions. Everything happens in your browser, so a +refresh will wipe any loaded transactions. Access the live version on GitHub Pages! [erfanio.github.io/up-transaction-tagger](https://erfanio.github.io/up-transaction-tagger/) @@ -10,25 +10,31 @@ Access the live version on GitHub Pages! [erfanio.github.io/up-transaction-tagge ## FAQ -### What's an API key? +### What's an API or Perosnal Access Token? -Your API key uniquely identifies you with Up Bank. It allows anyone that knows your -API key to read your transactions and add/update tags and categories. +Up Bank provides an interface for third-party applications (such as this one) to +read your transactions and add/update categories or tags to them. This is called +an application programming interface (API) and your **personal access token** is +a unique identifier that allows applications to access your trasaction data +using the API. -Go to [api.up.com.au](http://api.up.com.au) to get your API key! +You can get your personal access token from [api.up.com.au](http://api.up.com.au). +You can revoke the previous token by generating a new one any time. ### I see "Covered from X" or "Forwarded to X" transactions... what gives? -Covers and fowards are transactions under the hood. The Up app hides these transactions -under pretty UI but they're still there. +Covers and fowards are transactions under the hood. The Up app hides these +transactions under pretty UI but they're still there. -These transactions show up in the API but they don't mark which transaction they're -covering. I have an [open GitHub issue](https://github.com/up-banking/api/issues/99) -with Up to add this feature. +These transactions show up in the API but they don't mark which transaction +they're covering. I have an +[open GitHub issue](https://github.com/up-banking/api/issues/99) with Up to add +this feature. -For now, this web app uses heuristics to find likely covers/forwards and displays them a similar -UI to the app. +For now, this web app uses heuristics to find likely covers/forwards and displays +them a similar UI to the app. ### Can I shift select? -YES! The web app supports selecting multiple transactions in a row if you hold the shift key. +YES! The web app supports selecting multiple transactions in a row if you hold the +shift key. diff --git a/public/index.html b/public/index.html index efbc007..c7249ed 100644 --- a/public/index.html +++ b/public/index.html @@ -7,36 +7,13 @@ content="width=device-width, initial-scale=1, shrink-to-fit=no" /> - - - -