Skip to content

Commit 003db9a

Browse files
committed
add docs on how to install it in a project
1 parent 0eec0d3 commit 003db9a

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

README.md

+31
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,37 @@ A flutter package designed to sit on top of [FlutterBleLib](https://github.com/d
66

77
Currently the library only supports retrieving simple workout summary information from the erg (date and time of workout, duration of workout, distance, average strokes per minute) after the conclusion of a workout. More features beyond that are currently planned.
88

9+
## Installation
10+
11+
To install this package, just like any other flutter package, it needs to be included in your pubspec.yaml. Here are some templates for doing so:
12+
13+
**Pub.dev version**
14+
To install from pub.dev, use the following snippet:
15+
16+
[Snippet TBD - Package not yet published.]
17+
18+
**From git**
19+
20+
To install as a [git dependency](https://dart.dev/tools/pub/dependencies#git-packages), use the following snippet:
21+
22+
```yaml
23+
c2bluetooth:
24+
git:
25+
url: [email protected]:CrewLab/c2bluetooth.git
26+
ref: v0.1.0
27+
```
28+
29+
In this example, the value of the `ref` setting determines what branch/tag/commit it will use. this is useful if you want to lock your install to a particular version. If you want to use the bleeding-edge version, set this to `main`.
30+
31+
*Note*: This snippet assumes you have git configured correctly to be able to access the repository over SSH and have the correct auth (i.e. ssh keys) to access it without typing in your credentials. See the [dart docs](https://dart.dev/tools/pub/dependencies#git-packages) for more information
32+
33+
**Locally**
34+
For the most bleeding-edge experience - or if you plan to make and test changes to this library in realtime, it is recommended that you clone the library and use a relative path dependency as shown:
35+
36+
```yaml
37+
c2bluetooth:
38+
path: ../c2bluetooth
39+
```
940
## Usage
1041
TBD
1142

0 commit comments

Comments
 (0)