Merge pull request #24 from 1Password/libutcher-patch-1

Update README for beta

Author: Marton6

README.md

@@ -1,27 +1,60 @@
-# 1Password Python SDK
+<p align="center">
+  <a href="https://1password.com">
+      <h1 align="center">1Password Python SDK (beta)</h1>
+  </a>
+</p>
 
-> ❗ This project is still in its early, pre-alpha stages of development. Its stability is not yet fully assessed, and future iterations may bring backwards incompatible changes. Proceed with caution.
+<p align="center">
+ <h4 align="center"> ❗ The 1Password SDK project is in beta. Future iterations may bring backwards-incompatible changes.</h4>
+</p>
 
-The 1Password Python SDK offers programmatic read access to your secrets in 1Password in an interface native to Python. The SDK currently supports authentication with [1Password Service Accounts](https://developer.1password.com/docs/service-accounts/).
+<p align="center">
+  <a href="https://github.com/1Password/onepassword-sdk-python/tree/main/example">Examples</a>
+<br/>
 
-## Get started
+---
+
+The 1Password Python SDK offers programmatic access to your secrets in 1Password with Python. During the beta, you can create, retrieve, update, and delete items and resolve secret references.
+
+## 🔑 Authentication
+
+1Password SDKs support authentication with [1Password Service Accounts](https://developer.1password.com/docs/service-accounts/get-started/). You can create service accounts if you're an owner or administrator on your team. Otherwise, ask your administrator for a service account token.
+
+Before you get started, [create a service account](https://developer.1password.com/docs/service-accounts/get-started/#create-a-service-account) and give it the appropriate permissions in the vaults where the items you want to use with the SDK are saved.
+
+## ❗ Limitations
+
+1Password SDKs currently only support operations on text and concealed fields. If you update or delete an item that has information saved in other field types, that information will be permanently lost.
+
+1Password SDKs don't yet support using secret references with query parameters, so you can't retrieve file attachments or SSH keys, or get more information about field metadata.
+
+When managing items with 1Password SDKs, you must use unique identifiers (IDs) in place of vault, item, and field names.
+
+## 🚀 Get started
 
 To use the 1Password Python SDK in your project:
 
-1. [Create a 1Password Service Account](https://developer.1password.com/docs/service-accounts/get-started/#create-a-service-account). You can create service accounts if you're an owner or administrator on your team. Otherwise, ask your administrator for a service account token.
-2. Export your service account token to the `OP_SERVICE_ACCOUNT_TOKEN` environment variable:
+1. Provision your [service account](#authentication) token. We recommend provisioning your token from the environment. For example, to export your token to the `OP_SERVICE_ACCOUNT_TOKEN` environment variable:
 
-```bash
-export OP_SERVICE_ACCOUNT_TOKEN=<your-service-account-token>
-```
+   **macOS or Linux**
 
-3. In your project, download the 1Password Python SDK:
+   ```bash
+   export OP_SERVICE_ACCOUNT_TOKEN=<your-service-account-token>
+   ```
 
-```bash
-pip install git+ssh://[email protected]/1Password/onepassword-sdk-python.git
-```
+   **Windows**
+
+   ```powershell
+   $Env:OP_SERVICE_ACCOUNT_TOKEN = "<your-service-account-token>"
+   ```
+
+2. Install the 1Password Python SDK in your project:
 
-4. Use the SDK in your project:
+   ```bash
+   pip install git+ssh://[email protected]/1Password/[email protected]
+   ```
+
+3. Use the Python SDK in your project:
 
 ```python
 import asyncio
@@ -31,21 +64,19 @@ from onepassword.client import Client
 async def main():
     # Gets your service account token from the OP_SERVICE_ACCOUNT_TOKEN environment variable.
     token = os.getenv("OP_SERVICE_ACCOUNT_TOKEN")
-    
+
     # Connects to 1Password.
     client = await Client.authenticate(auth=token, integration_name="My 1Password Integration", integration_version="v1.0.0")
-   
+
     # Retrieves a secret from 1Password. Takes a secret reference as input and returns the secret to which it points.
     value = await client.secrets.resolve("op://vault/item/field")
-    print(value)
+    # use value here
 
 if __name__ == '__main__':
     asyncio.run(main())
 
 ```
 
-Make sure to use [secret reference URIs](https://developer.1password.com/docs/cli/secret-references/) with the syntax `op://vault/item/field` to securely load secrets from 1Password into your code.
-
-Note: The SDK doesn't yet support using secret references with query parameters, so you can't use secret references to retrieve file attachments or SSH keys, or to get more information about field metadata.
+Make sure to use [secret reference URIs](https://developer.1password.com/docs/cli/secrets-reference-syntax/) with the syntax `op://vault/item/field` to securely load secrets from 1Password into your code.
 
-Inside ```Client.authenticate(...)```, set ```integration_name``` to the name of your application and ```integration_version``` to the version of your application.
+Inside `Client.authenticate(...)`, set `integration_name` to the name of your application and `integration_version` to the version of your application.