Skip to content

Commit

Permalink
updated readme, changelog, pubspec. Added license and printers page
Browse files Browse the repository at this point in the history
  • Loading branch information
andrey-ushakov committed Mar 10, 2020
1 parent 48b91c2 commit 47e9441
Show file tree
Hide file tree
Showing 6 changed files with 51 additions and 59 deletions.
5 changes: 2 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@
## [0.0.1] - TODO: Add release date.

* TODO: Describe initial release.
## [0.1.0]
* Android and iOS Bluetooth printing support
28 changes: 27 additions & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1 +1,27 @@
TODO: Add your license here.
Copyright (c) 2020 Andrey Ushakov. All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following
disclaimer in the documentation and/or other materials provided
with the distribution.
* Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived
from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
16 changes: 6 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,15 @@
# esc_pos_bluetooth

The library allows to print receipts using an ESC/POS thermal WiFi/Ethernet printer.
The library allows to print receipts using a Bluetooth printer. For WiFi/Ethernet printers, use [esc_pos_printer](https://github.com/andrey-ushakov/esc_pos_printer) library.

[[pub.dev page]](https://pub.dev/packages/esc_pos_printer)
| [[Documentation]](https://pub.dev/documentation/esc_pos_printer/latest/)
[[pub.dev page]](https://pub.dev/packages/esc_pos_bluetooth)
| [[Documentation]](https://pub.dev/documentation/esc_pos_bluetooth/latest/)

It can be used in [Flutter](https://flutter.dev/) or pure [Dart](https://dart.dev/) projects. For Flutter projects, both Android and iOS are supported.

To scan for printers in your network, consider using [ping_discover_network](https://pub.dev/packages/ping_discover_network) package. Note that most of the ESC/POS printers by default listen on port 9100.

**Here are some [printers tested with this library](printers.md). Please add your models you have tested to maintain and improve this library and help others to choose the right printer.**
## Tested Printers
Here are some [printers tested with this library](printers.md). Please add your models you have tested to maintain and improve this library and help others to choose the right printer.

## Main Features

* Connect to Wi-Fi / Ethernet printers
* Android / iOS support
* Simple text printing using *text* method
* Tables printing using *row* method
* Text styling:
Expand Down
11 changes: 11 additions & 0 deletions printers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Tested Printers
Please add here printer models you have used with this library and any comments (works / something goes wrong).

This will help to maintain and improve this library and to choose the right printer.

Thank you for your collaboration!

## Bluetooth Printers List
| Model | Paper | Library Ver. | Comments |
|---|---|---|---|
| [MUNBYN IMP034-BK](https://images-na.ssl-images-amazon.com/images/I/514cEfTx%2BtL._SL1000_.jpg) | 58mm | 0.1.0 | No issues (Android, iOS) |
42 changes: 3 additions & 39 deletions pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
name: esc_pos_bluetooth
description: A new Flutter package project.
version: 0.0.1
author:
homepage:
description: The library allows to print receipts using an ESC/POS thermal Bluetooth printer.
version: 0.1.0
homepage: https://github.com/andrey-ushakov/esc_pos_bluetooth

environment:
sdk: ">=2.1.0 <3.0.0"
Expand All @@ -15,39 +14,4 @@ dev_dependencies:
flutter_test:
sdk: flutter

# For information on the generic Dart part of this file, see the
# following page: https://dart.dev/tools/pub/pubspec

# The following section is specific to Flutter.
flutter:

# To add assets to your package, add an assets section, like this:
# assets:
# - images/a_dot_burr.jpeg
# - images/a_dot_ham.jpeg
#
# For details regarding assets in packages, see
# https://flutter.dev/assets-and-images/#from-packages
#
# An image asset can refer to one or more resolution-specific "variants", see
# https://flutter.dev/assets-and-images/#resolution-aware.

# To add custom fonts to your package, add a fonts section here,
# in this "flutter" section. Each entry in this list should have a
# "family" key with the font family name, and a "fonts" key with a
# list giving the asset and other descriptors for the font. For
# example:
# fonts:
# - family: Schyler
# fonts:
# - asset: fonts/Schyler-Regular.ttf
# - asset: fonts/Schyler-Italic.ttf
# style: italic
# - family: Trajan Pro
# fonts:
# - asset: fonts/TrajanPro.ttf
# - asset: fonts/TrajanPro_Bold.ttf
# weight: 700
#
# For details regarding fonts in packages, see
# https://flutter.dev/custom-fonts/#from-packages
8 changes: 2 additions & 6 deletions test/esc_pos_bluetooth_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,7 @@ import 'package:flutter_test/flutter_test.dart';
import 'package:esc_pos_bluetooth/esc_pos_bluetooth.dart';

void main() {
test('adds one to input values', () {
final calculator = Calculator();
expect(calculator.addOne(2), 3);
expect(calculator.addOne(-7), -6);
expect(calculator.addOne(0), 1);
expect(() => calculator.addOne(null), throwsNoSuchMethodError);
test('Tests not implemented', () {
expect(1, 1);
});
}

0 comments on commit 47e9441

Please sign in to comment.