summaryrefslogtreecommitdiffstats
path: root/protos/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'protos/README.md')
-rw-r--r--protos/README.md52
1 files changed, 52 insertions, 0 deletions
diff --git a/protos/README.md b/protos/README.md
new file mode 100644
index 0000000..528e331
--- /dev/null
+++ b/protos/README.md
@@ -0,0 +1,52 @@
+<!--
+This README describes the package. If you publish this package to pub.dev,
+this README's contents appear on the landing page for your package.
+
+For information about how to write a good package README, see the guide for
+[writing package pages](https://dart.dev/guides/libraries/writing-package-pages).
+
+For general information about developing packages, see the Dart guide for
+[creating packages](https://dart.dev/guides/libraries/create-library-packages)
+and the Flutter guide for
+[developing packages and plugins](https://flutter.dev/developing-packages).
+-->
+
+
+
+
+<!--
+
+How to generate proto files:
+Makre sure you have installed protobuff and .pub-cache/bin added to path: ie:
+export PATH="$PATH:$HOME/.pub-cache/bin"
+run:
+'protoc --dart_out=grpc:lib/src/generated -Iprotos protos/*'
+-->
+
+
+TODO: Put a short description of the package here that helps potential users
+know whether this package might be useful for them.
+
+## Features
+
+TODO: List what your package can do. Maybe include images, gifs, or videos.
+
+## Getting started
+
+TODO: List prerequisites and provide or point to information on how to
+start using the package.
+
+## 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.