Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
EinarArnason authored Oct 12, 2018
1 parent df31b6e commit c14c220
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
# ArduinoQueue
A lightweight linked list type queue implementation, meant for microcontrollers.
Written as a C++ template class.

## Example:
`Queue<int> intQueue;`

all the T's will then be replaced by int.

Note that while the Queue class cleans up the nodes in memory after destructor or dequeue is called, it keeps a copy of the item being queued. So for example if you are queuing pointers, you will need to keep track of the memory behind them.

0 comments on commit c14c220

Please sign in to comment.