Readme improvements (#165)
file:
- Fix outdated pub URL
file_testing:
- Added pub version badge to file_testing
- Fixed example in file_testing
both:
- Removed gratuitous titles
diff --git a/packages/file/README.md b/packages/file/README.md
index 607e5a8..c8e3e30 100644
--- a/packages/file/README.md
+++ b/packages/file/README.md
@@ -1,7 +1,5 @@
[![Build Status](https://travis-ci.org/google/file.dart.svg?branch=master)](https://travis-ci.org/google/file.dart)
-[![pub package](https://img.shields.io/pub/v/file.svg)](https://pub.dartlang.org/packages/file)
-
-# File
+[![pub package](https://img.shields.io/pub/v/file.svg)](https://pub.dev/packages/file)
A generic file system abstraction for Dart.
diff --git a/packages/file_testing/README.md b/packages/file_testing/README.md
index ca6c652..9897deb 100644
--- a/packages/file_testing/README.md
+++ b/packages/file_testing/README.md
@@ -1,4 +1,4 @@
-# file_testing
+[![pub package](https://img.shields.io/pub/v/file_testing.svg)](https://pub.dev/packages/file_testing)
Testing utilities intended to work with `package:file`
@@ -11,22 +11,28 @@
```dart
import 'package:file/file.dart';
+import 'package:file/memory.dart';
import 'package:file_testing/file_testing.dart';
import 'package:test/test.dart';
-test('some test', () {
+void main() {
MemoryFileSystem fs;
setUp(() {
- fs = new MemoryFileSystem();
+ fs = MemoryFileSystem();
fs.file('/foo').createSync();
});
- expectFileSystemException(ErrorCodes.ENOENT, () {
- fs.directory('').resolveSymbolicLinksSync();
+ test('some test', () {
+ expectFileSystemException(
+ ErrorCodes.ENOENT,
+ () {
+ fs.directory('').resolveSymbolicLinksSync();
+ },
+ );
+ expect(fs.file('/path/to/file'), isFile);
+ expect(fs.file('/path/to/directory'), isDirectory);
+ expect(fs.file('/foo'), exists);
});
- expect(fs.file('/path/to/file'), isFile);
- expect(fs.file('/path/to/directory'), isDirectory);
- expect(fs.file('/foo'), exists);
-});
+}
```