Adds Getting Started instructions to README and CLA checks (#17)

* Adds Getting Started instructions to README

* Retriever base type (#16)

* Refactored Retriever object

* Added comment about Embedder type in docstring

* Adds Getting Started instructions and CLA Check workflow

.github/workflows/cla-check.yaml

@@ -0,0 +1,32 @@
+name: "CLA Check"
+
+on:
+  pull_request_target:
+    branches:
+      - main
+
+jobs:
+  cla-check:
+    if: github.event.pull_request.user.login != 'renovate[bot]'
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
+        with:
+          repository: neo-technology/whitelist-check
+          token: ${{ secrets.CLA_CHECK_TOKEN }}
+      - uses: actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d # v5
+        with:
+          python-version: 3
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+      - run: |
+          owner=$(echo "$GITHUB_REPOSITORY" | cut -d/ -f1)
+          repository=$(echo "$GITHUB_REPOSITORY" | cut -d/ -f2)
+
+          ./bin/examine-pull-request "$owner" "$repository" "${{ secrets.CLA_CHECK_TOKEN }}" "$PULL_REQUEST_NUMBER" cla-database.csv
+        env:
+          PULL_REQUEST_NUMBER: ${{ github.event.number }}

README.md

@@ -2,6 +2,8 @@
 
 This repository contains the official Neo4j GenAI features for Python.
 
+# Usage
+
 ## Installation
 
 This package requires Python (>=3.8.1).
@@ -74,6 +76,45 @@ print(retriever.search(query_vector=query_vector, top_k=5))
 poetry install
 ```
 
+
+## Getting started
+
+### Issues
+
+If you have a bug to report or feature to request, first
+[search to see if an issue already exists](https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests#search-by-the-title-body-or-comments).
+If a related issue doesn't exist, please raise a new issue using the relevant
+[issue form](https://github.com/neo4j/neo4j-genai-python/issues/new/choose).
+
+If you're a Neo4j Enterprise customer, you can also reach out to [Customer Support](http://support.neo4j.com/).
+
+If you don't have a bug to report or feature request, but you need a hand with
+the library; community support is available via [Neo4j Online Community](https://community.neo4j.com/)
+and/or [Discord](https://discord.gg/neo4j).
+
+### Make changes
+
+1. Fork the repository.
+2. Install Python and Poetry. For more information, see [the development guide](./docs/contributing/DEVELOPING.md).
+3. Create a working branch from `main` and start with your changes!
+
+### Pull request
+
+When you're finished with your changes, create a pull request, also known as a PR.
+
+* Ensure that you have [signed the CLA](https://neo4j.com/developer/contributing-code/#sign-cla).
+* Ensure that the base of your PR is set to `main`.
+* Don't forget to [link your PR to an issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue)
+if you are solving one.
+* Enable the checkbox to [allow maintainer edits](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork)
+so that maintainers can make any necessary tweaks and update your branch for merge.
+* Reviewers may ask for changes to be made before a PR can be merged, either using
+[suggested changes](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/incorporating-feedback-in-your-pull-request)
+or normal pull request comments. You can apply suggested changes directly through
+the UI, and any other changes can be made in your fork and committed to the PR branch.
+* As you update your PR and apply changes, mark each conversation as [resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations).
+
+
 ## Run tests
 
 Open a new virtual environment and then run the tests.