From 8ec4b523fd3551a832b32e740258d02cd65092ed Mon Sep 17 00:00:00 2001 From: Felix Angelov Date: Fri, 15 Sep 2023 11:55:10 -0500 Subject: [PATCH] chore(redis_client): prepare for 0.0.1 release (#1272) --- packages/redis_client/CHANGELOG.md | 3 ++ packages/redis_client/LICENSE | 19 +++++++++ packages/redis_client/README.md | 41 +++++++++++++++---- packages/redis_client/example/main.dart | 2 +- ...lient.dart => shorebird_redis_client.dart} | 0 packages/redis_client/pubspec.yaml | 10 +++-- .../test/src/redis_client_test.dart | 2 +- 7 files changed, 62 insertions(+), 15 deletions(-) create mode 100644 packages/redis_client/CHANGELOG.md create mode 100644 packages/redis_client/LICENSE rename packages/redis_client/lib/{redis_client.dart => shorebird_redis_client.dart} (100%) diff --git a/packages/redis_client/CHANGELOG.md b/packages/redis_client/CHANGELOG.md new file mode 100644 index 00000000..23f4b41c --- /dev/null +++ b/packages/redis_client/CHANGELOG.md @@ -0,0 +1,3 @@ +# 0.0.1 + +- feat: initial release ๐ŸŽ‰ diff --git a/packages/redis_client/LICENSE b/packages/redis_client/LICENSE new file mode 100644 index 00000000..6802bc4b --- /dev/null +++ b/packages/redis_client/LICENSE @@ -0,0 +1,19 @@ +MIT License + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/packages/redis_client/README.md b/packages/redis_client/README.md index e55e4b28..7efbb8f4 100644 --- a/packages/redis_client/README.md +++ b/packages/redis_client/README.md @@ -1,18 +1,18 @@ -# Redis Client +# ๐Ÿฆ Shorebird Redis Client +[![pub package](https://img.shields.io/pub/v/shorebird_redis_client.svg)](https://pub.dev/packages/shorebird_redis_client) +[![ci](https://github.com/shorebirdtech/shorebird/actions/workflows/main.yaml/badge.svg)](https://github.com/shorebirdtech/shorebird/actions/workflows/main.yaml) +[![codecov](https://codecov.io/gh/shorebirdtech/shorebird/branch/main/graph/badge.svg)](https://codecov.io/gh/shorebirdtech/shorebird) [![License: MIT][license_badge]][license_link] -A Dart library for interacting with [Redis](https://redis.io). +A Dart library for interacting with a [Redis](https://redis.io) server. -[license_badge]: https://img.shields.io/badge/license-MIT-blue.svg -[license_link]: https://opensource.org/licenses/MIT +Built with ๐Ÿ’™ by [Shorebird](https://shorebird.dev). -## Quick Start +## Quick Start ๐Ÿš€ ```dart -import 'dart:async'; - -import 'package:redis_client/redis_client.dart'; +import 'package:shorebird_redis_client/shorebird_redis_client.dart'; Future main() async { // Create an instance of a RedisClient. @@ -35,7 +35,27 @@ Future main() async { } ``` -## License +## Testing ๐Ÿงช + +To run the tests locally, ensure you have [Docker](https://www.docker.com) installed and pull the redis-stack-server image: + +```sh +docker pull redis/redis-stack-server +``` + +Then, start the server: + +```sh +docker run -p 6379:6379 --rm -e REDIS_ARGS="--requirepass password" redis/redis-stack-server +``` + +Now you can run the tests locally: + +```sh +dart test +``` + +## License ๐Ÿ“ƒ Shorebird packages are licensed for use under either Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0) MIT license @@ -44,3 +64,6 @@ Shorebird packages are licensed for use under either Apache License, Version 2.0 See our license philosophy for more information on why we license files this way: https://github.com/shorebirdtech/handbook/blob/main/engineering.md#licensing-philosophy + +[license_badge]: https://img.shields.io/badge/license-MIT-blue.svg +[license_link]: https://opensource.org/licenses/MIT diff --git a/packages/redis_client/example/main.dart b/packages/redis_client/example/main.dart index 80abd69a..838aff42 100644 --- a/packages/redis_client/example/main.dart +++ b/packages/redis_client/example/main.dart @@ -1,4 +1,4 @@ -import 'package:redis_client/redis_client.dart'; +import 'package:shorebird_redis_client/shorebird_redis_client.dart'; Future main() async { // Create an instance of a RedisClient. diff --git a/packages/redis_client/lib/redis_client.dart b/packages/redis_client/lib/shorebird_redis_client.dart similarity index 100% rename from packages/redis_client/lib/redis_client.dart rename to packages/redis_client/lib/shorebird_redis_client.dart diff --git a/packages/redis_client/pubspec.yaml b/packages/redis_client/pubspec.yaml index db724fed..953071b0 100644 --- a/packages/redis_client/pubspec.yaml +++ b/packages/redis_client/pubspec.yaml @@ -1,7 +1,9 @@ -name: redis_client -description: A Dart library for interacting with Redis. -version: 1.0.0+1 -publish_to: none +name: shorebird_redis_client +description: A lightweight Dart client library for communicating with a Redis server. Built by Shorebird. +version: 0.0.1 +homepage: https://shorebird.dev +repository: https://github.com/shorebirdtech/shorebird/tree/main/packages/redis_client +topics: [redis, cache, shorebird] environment: sdk: ">=3.0.0 <4.0.0" diff --git a/packages/redis_client/test/src/redis_client_test.dart b/packages/redis_client/test/src/redis_client_test.dart index 7311cf91..2e4ef0dc 100644 --- a/packages/redis_client/test/src/redis_client_test.dart +++ b/packages/redis_client/test/src/redis_client_test.dart @@ -1,7 +1,7 @@ import 'dart:async'; import 'dart:io'; -import 'package:redis_client/redis_client.dart'; +import 'package:shorebird_redis_client/shorebird_redis_client.dart'; import 'package:test/test.dart'; void main() {