From 5a304a8f644cda5cde249ce3b4a677fb6ecc3ba9 Mon Sep 17 00:00:00 2001 From: NickSwainston Date: Thu, 9 Nov 2023 00:22:46 +1100 Subject: [PATCH] Updated README.md --- README.md | 21 ++++----------------- 1 file changed, 4 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 8d73d89..bdbf9cc 100644 --- a/README.md +++ b/README.md @@ -17,27 +17,14 @@ or if you don't use poetry, you can instead run pip install . ``` -To use the database you need a download token to read it or an ingest token to read and write/upload to it. +To interact with the database you need to get an account on the [pulsars.org.au](https://pulsars.org.au) website. +Once you have an account you then need to generate a token on this [page](https://pulsars.org.au/token_generate/). -To get a read token run -``` -get_token.sh -``` - -The output token should be set as an environment variable using +Set this token using the following command (you can put this in your `~/.bashrc`): ``` export PSRDB_TOKEN=tokenhere -export PSRDB_URL=https://pulsars.org.au/api/graphql/ ``` ## How to use -The command line interface can be used to list various tables in the database. -The first arguments is the table name and the second is the action. -For example if I wanted to list all observations of pulsar J1652-4838 I could use: - -``` -meerdb observations list --pulsar J1652-4838 -``` - -If you're unsure which arguments you require you can use `-h` to list your options. \ No newline at end of file +Instructions and examples of how to use `psrdb` can be found in the [documentation](https://psrdb.readthedocs.io/en/latest/how_to_use.html). \ No newline at end of file