Skip to content

Commit

Permalink
removed excess code, updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
bararchy committed Mar 10, 2018
1 parent e89d00a commit cdcfd29
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 72 deletions.
30 changes: 24 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# bluetooth

TODO: Write a description here
This project is a try at Bluez C binding with Crystal

## Installation

Expand All @@ -9,29 +9,47 @@ Add this to your application's `shard.yml`:
```yaml
dependencies:
bluetooth:
github: [your-github-name]/bluetooth
github: bararchy/bluetooth
```
## Usage
```crystal
require "bluetooth"
local_device = Bluetooth::LocalDevice.new
remote_devices = local_device.scan
local_device.close

# remote_devices is a Hash(String, String) of address => name
p remote_devices
=> {
"00:11:22:33:FF:EE" => "Android Phone"
}

```

TODO: Write usage instructions here

## Development

TODO: Write development instructions here
* [ ] Bluetooth
* [x] Scan for remote devices.
* [ ] Connect to remote devices.
* [ ] Enumarate services.
* [ ] Handle different services like media, sounds, etc..
* [ ] BLE
* [ ] Scan for remote devices.
* [ ] Connect to remote devices.
* [ ] Enumarate services.
* [ ] Send commands to remote services.

## Contributing

1. Fork it ( https://github.com/[your-github-name]/bluetooth/fork )
1. Fork it ( https://github.com/bararchy/bluetooth/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

## Contributors

- [[your-github-name]](https://github.com/[your-github-name]) Bar Hofesh - creator, maintainer
- [bararchy(https://github.com/bararchy) Bar Hofesh - creator, maintainer
26 changes: 0 additions & 26 deletions spec/bluetooth_spec.cr

This file was deleted.

22 changes: 0 additions & 22 deletions src/bluetooth/address.cr

This file was deleted.

18 changes: 0 additions & 18 deletions src/bluetooth/socket.cr

This file was deleted.

0 comments on commit cdcfd29

Please sign in to comment.