Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove warning labels on README #2

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Remove warning labels on README #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 5 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,16 @@
Configure USB Gadget functions on your Nerves-based embedded device using
ConfigFS.

## 🚨 This project is work-in-progress 🚨

The intention is that it will become a dependency of [`nerves_init_gadget`] to
allow for automatic configuration of USB Gadget devices as well as an API for
developers to configure their own custom USB Gadget configurations.
While you can use this library directly to configure custom USB gadget devices,
its primary function at the moment is to be used by [`nerves_init_gadget`] to
allow for automatic configuration of the default USB Gadget devices on targets
like `rpi0` and `bbb`.

[nerves_init_gadget]: https://github.com/nerves-project/nerves_init_gadget

## Installation

To use it directly in your project (i.e. without `nerves_init_gadget`, add
To use it directly in your project (i.e. without `nerves_init_gadget`), add
`usb_gadget` to your list of dependencies in `mix.exs`:

```elixir
Expand All @@ -26,4 +25,3 @@ end

Documentation can be found at
[https://hexdocs.pm/usb_gadget](https://hexdocs.pm/usb_gadget).