Update documentation

master
Jonas Franz 4 years ago
parent 845205e9dd
commit f6ec15f21f
Signed by: JonasFranzDEV
GPG Key ID: 7293A220B7C38080
  1. 31
      README.md
  2. 6
      pubspec.yaml

@ -1,14 +1,27 @@
# db_construction_site
Dart implementation of Deutsche Bahn's construction site API
Unofficial Dart implementation of Deutsche Bahn's construction site API. This library is not affiliated
with Deutsche Bahn (DB). Please note that the API might change in the future making this library incompatible.
## Getting Started
## Usage
This project is a starting point for a Dart
[package](https://flutter.dev/developing-packages/),
a library module containing code that can be shared easily across
multiple Flutter or Dart projects.
Add `db_construction_site` to your `pubspec.yaml`:
```yaml
dependencies:
db_construction_site: ^0.0.1
```
For help getting started with Flutter, view our
[online documentation](https://flutter.dev/docs), which offers tutorials,
samples, guidance on mobile development, and a full API reference.
Import the package `package:db_construction_site/db_construction_site.dart` and initiate a new instance of `DBConstructionSite`
you can pass another base url as a named constructor parameter if you'd like to.
```dart
import 'package:db_construction_site/db_construction_site.dart';
final constructionSite = DBConstructionSite();
```
or
```dart
import 'package:db_construction_site/db_construction_site.dart';
final constructionSite = DBConstructionSite(baseUrl: "https://your-new-base-url");
```

@ -1,9 +1,9 @@
name: db_construction_site
description: Dart implementation of Deutsche Bahn's construction site API
description: Unofficial Dart implementation of Deutsche Bahn's construction site API
version: 0.0.1
author: Jonas Franz
homepage: https://git.jfdev.de/JonasFranzDEV/db_construction_site
repository: https://git.jfdev.de/JonasFranzDEV/db_construction_site
issue_tracker: https://git.jfdev.de/JonasFranzDEV/db_construction_site/issues
environment:
sdk: '>=2.1.0 <3.0.0'

Loading…
Cancel
Save