chore(redis_client): prepare for 0.0.1 release (#1272)
This commit is contained in:
@@ -0,0 +1,3 @@
|
||||
# 0.0.1
|
||||
|
||||
- feat: initial release 🎉
|
||||
@@ -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.
|
||||
@@ -1,18 +1,18 @@
|
||||
# Redis Client
|
||||
# 🐦 Shorebird Redis Client
|
||||
|
||||
[](https://pub.dev/packages/shorebird_redis_client)
|
||||
[](https://github.com/shorebirdtech/shorebird/actions/workflows/main.yaml)
|
||||
[](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<void> main() async {
|
||||
// Create an instance of a RedisClient.
|
||||
@@ -35,7 +35,27 @@ Future<void> 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
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import 'package:redis_client/redis_client.dart';
|
||||
import 'package:shorebird_redis_client/shorebird_redis_client.dart';
|
||||
|
||||
Future<void> main() async {
|
||||
// Create an instance of a RedisClient.
|
||||
|
||||
@@ -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"
|
||||
|
||||
@@ -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() {
|
||||
|
||||
Reference in New Issue
Block a user