Skip to content

Commit c73a73a

Browse files
docs: remove all emojis from documentation (#207)
* docs: remove all emojis from documentation Remove emojis from README.md and CHANGELOG.md to maintain professional documentation style. This change will be used to test the v0.2.1 release process. * docs: fix corrupted text in README examples section Fixed garbled text in the database command examples that appeared to be the result of a bad merge or copy-paste error.
1 parent 1c1f02e commit c73a73a

File tree

2 files changed

+18
-24
lines changed

2 files changed

+18
-24
lines changed

CHANGELOG.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,14 @@ All notable changes to this project will be documented in this file.
88

99
- Remove test styles command and legacy code ([0d220c9](https://github.com/joshrotenberg/redisctl/commit/0d220c962416f6e225f7cadbe8db4c3df9c6e182))
1010

11-
### ⚙️ Miscellaneous Tasks
11+
### Miscellaneous Tasks
1212

1313
- Rename colliding examples to avoid filename collision\n\n- redis-cloud: basic.rs -> basic_cloud.rs (README + comment updated)\n- redis-enterprise: basic.rs -> basic_enterprise.rs (README + comment updated) ([b0bcdaa](https://github.com/joshrotenberg/redisctl/commit/b0bcdaa2de5467f43c6377e980c5b2f320715160))
1414
- Run tests on commit and push; install pre-push hook\n\n- .pre-commit-config.yaml: add stages for clippy/tests; add --workspace\n- scripts/install-hooks.sh: install pre-commit and pre-push hooks; update messages ([4c92b03](https://github.com/joshrotenberg/redisctl/commit/4c92b0326c85cae334cbf5a8dc02983e8ff3b8bf))
1515
- Update lock file after dependency changes ([06a1f9d](https://github.com/joshrotenberg/redisctl/commit/06a1f9dfcd9573e0c37131c3290ea8a425ba1403))
1616
- Remove unused scripts, Docker Compose testing, and pre-commit hooks ([804c358](https://github.com/joshrotenberg/redisctl/commit/804c3580d170ed68d82349f19e4f4ac825f3f958))
1717

18-
### Features
18+
### Features
1919

2020
- Improve redis-enterprise crate documentation and examples ([ae3caa9](https://github.com/joshrotenberg/redisctl/commit/ae3caa913d3b64e0e34f221ecbefee56be05010f))
2121
- Add all missing Enterprise CLI commands ([2e79b91](https://github.com/joshrotenberg/redisctl/commit/2e79b9171e6a3c7804a9cd4129233763de1d6cc4))
@@ -62,15 +62,15 @@ All notable changes to this project will be documented in this file.
6262
- Add --wait flag support for Cloud ACL commands ([1d652e8](https://github.com/joshrotenberg/redisctl/commit/1d652e879a2874dd7a0d01eb1f856bdb0f2e4c1a))
6363
- Implement comprehensive release automation system ([8514042](https://github.com/joshrotenberg/redisctl/commit/851404276c0b833e49c1b621b4bc3892df4f6f44))
6464

65-
### 🎨 Styling
65+
### Styling
6666

6767
- Rustfmt bdb handler changes for new endpoints ([442e278](https://github.com/joshrotenberg/redisctl/commit/442e278175c74d58490f068b5e59132e8da401e9))
6868
- Apply rustfmt and tidy tests; all new Cluster/Node endpoints covered by basic tests ([a335506](https://github.com/joshrotenberg/redisctl/commit/a33550608a4f7ba60b9cd3b27c6c33c8531ed32e))
6969
- Format code for Enterprise API coverage changes ([3edb474](https://github.com/joshrotenberg/redisctl/commit/3edb474bfb621404ca98e8f8a991f730e1e81823))
7070
- Fix clippy doc comment lint after raw removal ([5a14686](https://github.com/joshrotenberg/redisctl/commit/5a14686b87b91753d204ccccb3b35658101e6f26))
7171
- Apply cargo fmt across workspace ([5093f26](https://github.com/joshrotenberg/redisctl/commit/5093f26844a5f310a1e1d341d70997e0655def23))
7272

73-
### 🐛 Bug Fixes
73+
### Bug Fixes
7474

7575
- Correct cargo-dist workflow tag pattern ([84f97cb](https://github.com/joshrotenberg/redisctl/commit/84f97cbe4a7801ba3d21f4ec3b924a026360764e))
7676
- Add allow-dirty to cargo-dist config ([4808936](https://github.com/joshrotenberg/redisctl/commit/480893675fa3329ca14707cedd461b18cc502fb3))
@@ -123,7 +123,7 @@ All notable changes to this project will be documented in this file.
123123
- Remove internal dependency version updates from prepare-release workflow ([#204](https://github.com/joshrotenberg/redisctl/issues/204)) ([e99dcb0](https://github.com/joshrotenberg/redisctl/commit/e99dcb0911cb3051e920c05562b456a28a351e05))
124124
- Remove version constraints from workspace path dependencies ([#205](https://github.com/joshrotenberg/redisctl/issues/205)) ([e94466f](https://github.com/joshrotenberg/redisctl/commit/e94466fa714b1fea2ad7a193b4f7a37f349d1231))
125125

126-
### 📚 Documentation
126+
### Documentation
127127

128128
- Add contributing guide and update installation docs ([5893261](https://github.com/joshrotenberg/redisctl/commit/5893261a7d5fbabfa2cf26dfcfde4245a1b63b08))
129129
- Improve lib and module overviews; fix clippy doc warnings ([9fd5b2c](https://github.com/joshrotenberg/redisctl/commit/9fd5b2cb77ffc8e0f36863026feffb49181fb887))

README.md

Lines changed: 13 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,12 @@ A unified CLI for Redis Cloud and Redis Enterprise REST APIs with comprehensive
44

55
## Features
66

7-
- 🚀 **Unified Interface** - Single CLI for both Redis Cloud and Redis Enterprise
8-
-**Async Operations** - Full support for long-running operations with `--wait` flags
9-
- 🔄 **Smart Routing** - Automatically detects which API to use based on context
10-
- 📊 **Multiple Output Formats** - JSON, YAML, and Table output with JMESPath filtering
11-
- 🔐 **Secure Configuration** - Profile-based auth with environment variable support
12-
- 🌐 **Comprehensive Coverage** - Full API coverage for both platforms
13-
A unified CLI for Redis Cloud and Redis Enterprise REST APIs with comprehensive async operation support.
14-
15-
## Features
16-
17-
- 🚀 **Unified Interface** - Single CLI for both Redis Cloud and Redis Enterprise
18-
-**Async Operations** - Full support for long-running operations with `--wait` flags
19-
- 🔄 **Smart Routing** - Automatically detects which API to use based on context
20-
- 📊 **Multiple Output Formats** - JSON, YAML, and Table output with JMESPath filtering
21-
- 🔐 **Secure Configuration** - Profile-based auth with environment variable support
7+
- **Unified Interface** - Single CLI for both Redis Cloud and Redis Enterprise
8+
- **Async Operations** - Full support for long-running operations with `--wait` flags
9+
- **Smart Routing** - Automatically detects which API to use based on context
10+
- **Multiple Output Formats** - JSON, YAML, and Table output with JMESPath filtering
11+
- **Secure Configuration** - Profile-based auth with environment variable support
12+
- **Comprehensive Coverage** - Full API coverage for both platforms
2213

2314
## Installation
2415

@@ -77,10 +68,13 @@ redisctl database list
7768
# Create database with async wait
7869
redisctl cloud database create --data @database.json --wait
7970

80-
# Create database with async wait
81-
redisctl cloud database create
82-
# UpdateDifferent output
83-
redisctl Deletedatabaselist-o yaml | yq '.[] | select(.name == "prod")' database with force and wait
71+
# Update database with wait
72+
redisctl cloud database update 12345 --data @update.json --wait
73+
74+
# Different output formats with filtering
75+
redisctl database list -o yaml | yq '.[] | select(.name == "prod")'
76+
77+
# Delete database with force and wait
8478
redisctl cloud database delete 12345 --force --wait
8579
```
8680

0 commit comments

Comments
 (0)