Skip to content

Commit

Permalink
chore: adding some docs
Browse files Browse the repository at this point in the history
  • Loading branch information
robcxyz committed Jul 10, 2023
1 parent a3a4e79 commit 7513c73
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 7 deletions.
2 changes: 1 addition & 1 deletion .tackle.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<-:
help: Create a provider
help: Create a tackle provider with tests and a CI.

project_slug:
type: str
Expand Down
34 changes: 28 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,35 @@ pip install tackle
tackle sudoblockio/tackle-provider
```

Running `tackle sudoblockio/tackle-provider help`

```text
usage: tackle [--project_slug] [--project_name] [--description] [--author_name] [--author_email] [--repo_owner] [--default_branch] [--tackle_file] [--hooks_enable] [--tests_enable]
Create a tackle provider with tests and a CI.
options:
--project_slug [str]
--project_name [str]
--description [str]
--author_name [str]
--author_email [str]
--repo_owner [str]
--default_branch [str]
--tackle_file [str]
--hooks_enable [str]
--tests_enable [str]
```

Running `tackle sudoblockio/tackle-provider`

```text
? Name of your provider? Used in README.md title. My Provider
? Name of project slug? Actual repo name. tackle-my-provider
? A description of what the project is? A tackle box provider that does stuff
? What is your name? Used in README and LICENSE Rob Cannon
? What is your email? Used in README and LICENSE. Blank to leave out. nunyabiznis@gmail.com
? What is your github / org name? sudoblockio
? Name of project slug? Actual repo name. tackle-awesome-provider
? Name of your provider? Used in README.md title. Tackle Awesome Provider
? A description of what the project is? A tackle box provider that does awesome stuff...
? What is your name? Used in README and LICENSE Donald Duck
? What is your email? Blank to leave out. duckman5000@gmail.com
? What is your github / org name? dduck43
? What is going to be your default branch name?
❯ main
master
Expand Down

0 comments on commit 7513c73

Please sign in to comment.