From 7eb6f2e7fe387d1b5ba0acaebf5e81d3f5ced6b0 Mon Sep 17 00:00:00 2001 From: nharris Date: Thu, 1 Dec 2022 01:16:55 -0500 Subject: [PATCH] - Prep for initial release --- .gitignore | 13 +++++++++++++ .pubignore | 16 ++++++++++++++++ CHANGELOG.md | 4 ++-- README.md | 23 ++++++----------------- pubspec.yaml | 6 +++--- 5 files changed, 40 insertions(+), 22 deletions(-) create mode 100644 .gitignore create mode 100644 .pubignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..3ace476 --- /dev/null +++ b/.gitignore @@ -0,0 +1,13 @@ +# Files and directories created by pub. +.dart_tool/ +.packages + +# Conventional directory for build outputs. +build/ + +# Omit committing pubspec.lock for library packages; see +# https://dart.dev/guides/libraries/private-files#pubspeclock. +pubspec.lock + +# Ignore cassettes +cassettes diff --git a/.pubignore b/.pubignore new file mode 100644 index 0000000..1136083 --- /dev/null +++ b/.pubignore @@ -0,0 +1,16 @@ +# Files and directories created by pub. +.dart_tool/ +.packages + +# Conventional directory for build outputs. +build/ + +# Omit committing pubspec.lock for library packages; see +# https://dart.dev/guides/libraries/private-files#pubspeclock. +pubspec.lock + +# Ignore cassettes +cassettes/ + +# Ignore tests +tests/ diff --git a/CHANGELOG.md b/CHANGELOG.md index effe43c..951a5a3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,3 @@ -## 1.0.0 +## 0.1.0 -- Initial version. +- Initial release. diff --git a/README.md b/README.md index 8b55e73..1aaf7a8 100644 --- a/README.md +++ b/README.md @@ -11,29 +11,18 @@ and the Flutter guide for [developing packages and plugins](https://flutter.dev/developing-packages). --> -TODO: Put a short description of the package here that helps potential users -know whether this package might be useful for them. +A Dart package for recording and replaying HTTP interactions. Useful for testing, mocking, and more. + +Port of EasyVCR. ## Features -TODO: List what your package can do. Maybe include images, gifs, or videos. +To come. ## Getting started -TODO: List prerequisites and provide or point to information on how to -start using the package. +To come. ## Usage -TODO: Include short and useful examples for package users. Add longer examples -to `/example` folder. - -```dart -const like = 'sample'; -``` - -## Additional information - -TODO: Tell users more about the package: where to find more information, how to -contribute to the package, how to file issues, what response they can expect -from the package authors, and more. +To come. diff --git a/pubspec.yaml b/pubspec.yaml index 47cfe10..8149e4e 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -1,7 +1,7 @@ name: dartvcr -description: A starting point for Dart libraries or applications. -version: 1.0.0 -# homepage: https://www.example.com +description: A Dart library for recording and replaying HTTP requests. Port of EasyVCR. +version: 0.1.0 +repository: https://github.com/nwithan8/dartvcr environment: sdk: '>=2.18.2 <3.0.0'