diff --git a/.github/workflows/doc-changes.yml b/.github/workflows/doc-changes.yml new file mode 100644 index 0000000..b7b9db0 --- /dev/null +++ b/.github/workflows/doc-changes.yml @@ -0,0 +1,23 @@ +name: doc-changes + +on: + pull_request_target: + branches: + - main + types: + - closed + +jobs: + latest-changes: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-python@v5 + with: + python-version: "3.11" + - run: pip install "laminci[doc-changes]@git+https://github.com/laminlabs/laminci" + - run: laminci doc-changes + env: + repo_token: ${{ secrets.GITHUB_TOKEN }} + docs_token: ${{ secrets.LAMIN_BUILD_DOCS }} + changelog_file: lamin-docs/docs/changelog/soon/laminr.md \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 8353cf5..afb76a7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -21,6 +21,8 @@ * Do not complain when foreign keys are not found in a record, but also do not complain when they are (PR #13). +* Update `README` with new set up instructions and simplify (PR #14). + ## BUG FIXES * Fixed the parsing of the env files in `~/.lamin` due to changes in the lamindb-setup Python package (PR #12). diff --git a/README.md b/README.md index f0e1172..f10ba7b 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,32 @@ -# LaminDB interface in R +# LaminR: Work with LaminDB instances in R + [![R-CMD-check](https://github.com/laminlabs/laminr/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/laminlabs/laminr/actions/workflows/R-CMD-check.yaml) -This package provides an interface to the LaminDB database. It allows -you to query the database and download data from it. +This package allows you to query and download data from LaminDB +instances. -## Installation +## Setup -You can install the development version from GitHub with: +Install the development version from GitHub: ``` r # install.packages("remotes") remotes::install_github("laminlabs/laminr") ``` -## Set up environment - -For this package to work, we first need to install `lamindb-setup` and -log in to LaminDB. +Install the Lamin CLI and authenticate: ``` bash -pip install lamindb-setup -lamin login --key +pip install lamin-cli +lamin login ``` > [!TIP] diff --git a/README.qmd b/README.qmd index fb94182..2cba7d5 100644 --- a/README.qmd +++ b/README.qmd @@ -1,30 +1,34 @@ --- -title: LaminDB interface in R +title: "LaminR: Work with LaminDB instances in R" format: gfm --- + + [![R-CMD-check](https://github.com/laminlabs/laminr/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/laminlabs/laminr/actions/workflows/R-CMD-check.yaml) -This package provides an interface to the LaminDB database. It allows you to query the database and download data from it. +This package allows you to query and download data from LaminDB instances. -## Installation +## Setup -You can install the development version from GitHub with: +Install the development version from GitHub: ```R # install.packages("remotes") remotes::install_github("laminlabs/laminr") ``` -## Set up environment - -For this package to work, we first need to install `lamindb-setup` and log in to LaminDB. +Install the Lamin CLI and authenticate: ```bash -pip install lamindb-setup -lamin login --key +pip install lamin-cli +lamin login ``` :::{.callout-tip}