Skip to content

Commit

Permalink
chore: update README and other default files (#22)
Browse files Browse the repository at this point in the history
The org and project's name has changed.

Closes #9
  • Loading branch information
DavidCardoso authored Sep 14, 2023
1 parent 5d7e34b commit 1060a81
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 20 deletions.
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ Example: steps to reproduce the behavior:
Note: List of related links and updated docs (READMEs, Notion, Google Docs, others links, etc).
-->

- [README](/tooling-dev/cli#readme)
- [README](/my-tooling/my-ez-cli#readme)
18 changes: 9 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Contribution Guidelines

Help wanted! We'd love your contributions to `Tooling Dev CLI`.
Help wanted! We'd love your contributions to `My Ez CLI`.

Please review the following guidelines before contributing.
Please review the following guidelines before contributing.

* [I have a question...](#have-a-question)
* [I found a bug...](#found-a-bug)
Expand All @@ -16,22 +16,22 @@ Also, feel free to propose changes to these guidelines by updating this file and
You can use [discussions](../../discussions) to interact with other community members, share new ideas and ask questions.

## Found a bug?
You can use [issues](../../issues) to report bugs. Choose the `bug template` and provide all the requested information, otherwise your issue could be closed.

You can use [issues](../../issues) to report bugs. Choose the `bug template` and provide all the requested information, otherwise your issue could be closed.

Please also feel free to submit a Pull Request with a fix for the bug! For sensitive security-related issues, please report via email: [dev+github@davidcardoso.me](mailto:dev+github@davidcardoso.me).

## Have a Feature Request?

All feature requests should start with [submitting an issue](../../issues/new) documenting the user story and acceptance criteria. Choose the `feature request template` and provide all the requested information, otherwise your issue could be closed.
All feature requests should start with [submitting an issue](../../issues/new) documenting the user story and acceptance criteria. Choose the `feature request template` and provide all the requested information, otherwise your issue could be closed.

Again, feel free to submit a `Pull Request` with a proposed implementation of the feature.
Again, feel free to submit a `Pull Request` with a proposed implementation of the feature.

## Ready to contribute

### Create an issue

Before submitting a [new issue](../../issues/new), please search the [issues](../../issues) to make sure there isn't a similar issue doesn't already exist.
Before submitting a [new issue](../../issues/new), please search the [issues](../../issues) to make sure there isn't a similar issue doesn't already exist.

Assuming no existing issues exist, please ensure you include the following bits of information when submitting the issue to ensure we can quickly reproduce your issue:

Expand All @@ -57,7 +57,7 @@ We may have additional questions and will communicate through the GitHub issue,
7. For a Pull Request to be merged:
* CI workflow must succeed
* A project member must review and approve it

The reviewer may have additional questions and will communicate through conversations in the GitHub PR, so please respond back to our questions or changes requested during review.

### <a name="style"></a> Styleguide
Expand All @@ -66,7 +66,7 @@ When submitting code, please make every effort to follow existing conventions an

### License

By contributing your code, you agree to license your contribution under the terms of the [MIT License](LICENSE).
By contributing your code, you agree to license your contribution under the terms of the [MIT License](LICENSE).

All files are released with the MIT License.

Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2022 Tooling Dev
Copyright (c) 2022 My Tooling

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Dev Tooling CLI
# My Ez CLI

Tools via **Unix Command Line Interface** with no installation and just using **Docker** + **Shell Script**.

- [Dev Tooling CLI](#dev-tooling-cli)
- [My Ez CLI](#my-ez-cli)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Usage examples](#usage-examples)
Expand All @@ -24,7 +24,7 @@ Tools via **Unix Command Line Interface** with no installation and just using **
## Prerequisites

- [Docker](https://www.docker.com/get-started).
- [Oh My Zsh](https://ohmyz.sh/).
- [Zshell + Oh My Zsh](https://ohmyz.sh/).

## Setup

Expand Down
4 changes: 1 addition & 3 deletions config/aws/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,13 @@ Configuration in `~/.aws/config`:
```
[profile my-sso-profile]
sso_start_url = https://yourcompany.awsapps.com/start
sso_region = us-east-1
sso_region = sa-east-1
sso_account_id = 1234567890
sso_role_name = RoleName
region = sa-east-1
output = json
```

> AWS SSO is a global service. So, use `sso_region = us-east-1` (N. Virginia).
> AWS SSO do not need `~/.aws/credentials` file.
### Scenario 2: Source profile and MFA authentication
Expand Down
6 changes: 3 additions & 3 deletions setup.sh
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ EOF
show_begin() {
cat <<EOF
==============================================================
Tooling Dev CLI Setup
My Ez CLI Setup
==============================================================
Hope you enjoy it! :D
==============================================================
Expand All @@ -48,7 +48,7 @@ show_begin() {
==============================================================
Warning: Root access may be needed.
==============================================================
GitHub: https://github.com/Tooling-Dev/cli
GitHub: https://github.com/My-Tooling/my-ez-cli
==============================================================
EOF
Expand Down Expand Up @@ -140,4 +140,4 @@ done

# End

show_msg "Thanks for using Tooling Dev CLI ;)"
show_msg "Thanks for using My Ez CLI ;)"

0 comments on commit 1060a81

Please sign in to comment.