Skip to content

Commit

Permalink
- Prep for initial release
Browse files Browse the repository at this point in the history
  • Loading branch information
nwithan8 committed Dec 1, 2022
1 parent c3ac0e7 commit 7eb6f2e
Show file tree
Hide file tree
Showing 5 changed files with 40 additions and 22 deletions.
13 changes: 13 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -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
16 changes: 16 additions & 0 deletions .pubignore
Original file line number Diff line number Diff line change
@@ -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/
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
## 1.0.0
## 0.1.0

- Initial version.
- Initial release.
23 changes: 6 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
6 changes: 3 additions & 3 deletions pubspec.yaml
Original file line number Diff line number Diff line change
@@ -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'
Expand Down

0 comments on commit 7eb6f2e

Please sign in to comment.