Jirwin/readme updates (#8)

* Update readme

* Add subdir for cmd for go install

* Fix typos

* More typo fixes

* More readme fixes. Add code of conduct

* Fix link to contributing guide

* More cleanup

* Drop extra header

* Grammar fix

* Fix badges

Author: jirwin

.goreleaser.docker.yaml

@@ -4,7 +4,7 @@ builds:
     env:
       - CGO_ENABLED=0
     id: linux
-    main: ./cmd
+    main: ./cmd/baton-github
     goos:
       - linux
     goarch:

.goreleaser.yaml

@@ -4,7 +4,7 @@ builds:
     env:
       - CGO_ENABLED=0
     id: linux
-    main: ./cmd
+    main: ./cmd/baton-github
     goos:
       - linux
     goarch:
@@ -14,7 +14,7 @@ builds:
     env:
       - CGO_ENABLED=0
     id: macos-amd64
-    main: ./cmd
+    main: ./cmd/baton-github
     goos:
       - darwin
     goarch:
@@ -27,7 +27,7 @@ builds:
     env:
       - CGO_ENABLED=0
     id: macos-arm64
-    main: ./cmd
+    main: ./cmd/baton-github
     goos:
       - darwin
     goarch:

CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[[email protected]](mailto:[email protected]).
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

Makefile

@@ -7,7 +7,7 @@ OUTPUT_PATH = ${BUILD_DIR}/$(notdir $(CURDIR))
 build:
 	rm -f ${OUTPUT_PATH}
 	mkdir -p ${BUILD_DIR}
-	go build -o ${OUTPUT_PATH} cmd/*.go
+	go build -o ${OUTPUT_PATH} cmd/baton-github/*.go
 
 .PHONY: update-deps
 update-deps:

README.md

@@ -1,6 +1,53 @@
-# baton-github
+![Baton Logo](./docs/images/baton-logo.png)
+
+# `baton-github` [![Go Reference](https://pkg.go.dev/badge/github.com/conductorone/baton-github.svg)](https://pkg.go.dev/github.com/conductorone/baton-github) ![main ci](https://github.com/conductorone/baton-github/actions/workflows/main.yaml/badge.svg)
+
+`baton-github` is a connector for GitHub built using the [Baton SDK](https://github.com/conductorone/baton-sdk). It communicates with the GitHub API to sync data about which teams and users have access to various repositories within an organization.
+
+Check out [Baton](https://github.com/conductorone/baton) to learn more about Baton.
+
+
+# Getting Started
+## brew
+```
+brew install conductor/baton/baton conductor/baton/baton-github
+
+BATON_TOKEN=githubAccessToken baton-github
+baton resources
+```
+
+## docker
+```
+docker run --rm -v $(pwd):/out -e BATON_TOKEN=githubAccessToken ghcr.io/conductorone/baton-github: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-github/cmd/baton-github@main
+
+BATON_TOKEN=githubAccessToken baton-github 
+baton resources
+```
+
+# 
+`baton-github` will pull down information about the following GitHub resources:
+- Organizations
+- Users
+- Teams
+- Repositories
+
+By default, `baton-github` will sync information from any organizations that the provided credential has Administrator permissions on. You can specify exactly which organizations you would like to sync using the `--orgs` flag.
+
+# 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, problems, or ideas: Please open a Github Issue!
+
+See [CONTRIBUTING.md](https://github.com/ConductorOne/baton/blob/main/CONTRIBUTING.md) for more details.
+
+# `baton-github` Command Line Usage
 
-## usage
 ```
 baton-github
 
@@ -13,14 +60,13 @@ Available Commands:
   help               Help about any command
 
 Flags:
-  -f, --file string           The path to the c1z file to sync with ($C1_FILE) (default "sync.c1z")
+  -f, --file string           The path to the c1z file to sync with ($BATON_FILE) (default "sync.c1z")
   -h, --help                  help for baton-github
-      --instance-url string   The GitHub instance URL to connect to. ($C1_INSTANCE_URL) (default "https://github.com")
-      --log-format string     The output format for logs: json, console ($C1_LOG_FORMAT) (default "json")
-      --log-level string      The log level: debug, info, warn, error ($C1_LOG_LEVEL) (default "info")
-      --orgs strings          Limit syncing to specific organizations. ($C1_ORGS)
-      --token string          The GitHub access token used to connect to the Github API. ($C1_TOKEN)
+      --instance-url string   The GitHub instance URL to connect to. ($BATON_INSTANCE_URL) (default "https://github.com")
+      --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")
+      --orgs strings          Limit syncing to specific organizations. ($BATON_ORGS)
+      --token string          The GitHub access token used to connect to the Github API. ($BATON_TOKEN)
   -v, --version               version for baton-github
 
-Use "baton-github [command] --help" for more information about a command.
-```
+Use "baton-github [command] --help" for more information about a command.