Update readme file

README.md

@@ -1,3 +1,90 @@
-# baton-teleport
-Welcome to your new connector! To start out, you will want to update the dependencies.
-Do this by running `make update-deps`.
+# `baton-teleport` [![Go Reference](https://pkg.go.dev/badge/github.com/conductorone/baton-teleport.svg)](https://pkg.go.dev/github.com/conductorone/baton-teleport) ![main ci](https://github.com/conductorone/baton-teleport/actions/workflows/main.yaml/badge.svg)
+`baton-teleport` is a connector for teleport built using the [Baton SDK](https://github.com/conductorone/baton-sdk). It communicates with the teleport API to sync data about users, groups and enterprise.
+
+Check out [Baton](https://github.com/conductorone/baton) to learn more the project in general.
+
+# Getting Started
+You can try out the teleport platform with a free, 14-day trial account. If you're interested in becoming a teleport developer partner, you can convert your trial account into a sponsored teleport Support account.
+
+As part of becoming a teleport developer partner, teleport sponsors an instance for up to 5 agents that you can use for developing, and troubleshooting your app or integration.
+
+Unlike a trial account, a sponsored account does not expire after 14 days.
+## Prerequisites
+
+1. teleport `trial account` sign up for a free teleport Support trial  [developer site](https://www.teleport.com/register/)
+2. Authentication method set to `Token access`
+3. Application Scopes: 
+  - members
+  - groups
+  - organizations
+  - grant resources
+  - revoke resources
+
+## brew
+
+```
+brew install conductorone/baton/baton conductorone/baton/baton-teleport
+baton-teleport
+baton resources
+```
+
+## docker
+
+```
+docker run --rm -v $(pwd):/out -e BATON_SUBDOMAIN=clientSubdomain BATON_EMAIL=clientEmail BATON_API_TOKEN=apiToken ghcr.io/conductorone/baton-teleport:latest -f "/out/sync.c1z"
+docker run --rm -v $(pwd):/out ghcr.io/conductorone/baton:latest -f "/out/sync.c1z" resources
+```
+
+## source
+
+```
+go install github.com/conductorone/baton/cmd/baton@main
+go install github.com/conductorone/baton-teleport/cmd/baton-teleport@main
+
+BATON_SUBDOMAIN=clientSubdomain BATON_EMAIL=clientEmail BATON_API_TOKEN=apiToken 
+baton resources
+```
+
+# Data Model
+
+`baton-teleport` pulls down information about the following teleport resources:
+- Team Members
+- Groups
+- Organizations
+- Roles
+
+# Contributing, Support, and Issues
+
+We started Baton because we were tired of taking screenshots and manually building spreadsheets. We welcome contributions, and ideas, no matter how small -- our goal is to make identity and permissions sprawl less painful for everyone. If you have questions, concerns, or ideas: Please open a Github Issue!
+
+See [CONTRIBUTING.md](https://github.com/ConductorOne/baton/blob/main/CONTRIBUTING.md) for more details.
+
+# `baton-teleport` Command Line Usage
+
+```
+baton-teleport
+
+Usage:
+  baton-teleport [flags]
+  baton-teleport [command]
+
+Available Commands:
+  capabilities       Get connector capabilities
+  completion         Generate the autocompletion script for the specified shell
+  help               Help about any command
+
+Flags:
+      --api-token string       The teleport apitoken. ($BATON_API_TOKEN)
+      --client-id string       The client ID used to authenticate with ConductorOne ($BATON_CLIENT_ID)
+      --client-secret string   The client secret used to authenticate with ConductorOne ($BATON_CLIENT_SECRET)
+      --email string           The teleport email. ($BATON_EMAIL)
+  -f, --file string            The path to the c1z file to sync with ($BATON_FILE) (default "sync.c1z")
+  -h, --help                   help for baton-teleport
+      --log-format string      The output format for logs: json, console ($BATON_LOG_FORMAT) (default "json")
+      --log-level string       The log level: debug, info, warn, error ($BATON_LOG_LEVEL) (default "info")
+  -p, --provisioning           This must be set in order for provisioning actions to be enabled. ($BATON_PROVISIONING)
+      --subdomain string       The teleport subdomain. ($BATON_SUBDOMAIN)
+  -v, --version                version for baton-teleport
+
+Use "baton-teleport [command] --help" for more information about a command.
+```