Skip to content

Commit

Permalink
fixed readme format
Browse files Browse the repository at this point in the history
  • Loading branch information
brianhks committed Sep 19, 2020
1 parent e405b50 commit 6a8830a
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ A big, fast and persistent queue based on memory mapped file.

***Double Notice***, I (Owner of Kairosdb) have forked this code with the intention of maintaining it. It is some amazing code and it has been neglected for a few years. BigQueue is a critical part of KairosDB and in other projects I've created.

##Feature Highlight:
## Feature Highlight:
1. **Fast**: close to the speed of direct memory access, both enqueue and dequeue are close to O(1) memory access.
2. **Big**: the total size of the queue is only limited by the available disk space.
3. **Persistent**: all data in the queue is persisted on disk, and is crash resistant.
Expand All @@ -20,12 +20,12 @@ A big, fast and persistent queue based on memory mapped file.

## The Big Picture

###Memory Mapped Sliding Window
### Memory Mapped Sliding Window

![design](http://bulldog2011.github.com/images/luxun/sliding_window.png)


##Performance Highlight:
## Performance Highlight:
* In concurrent producing and consuming case, the average throughput is around ***166M bytes per second***.
* In sequential producing then consuming case, the average throughput is around ***333M bytes per second***.

Expand All @@ -34,7 +34,7 @@ Suppose the average message size is 1KB, then big queue can concurrently produci

[here is a detailed performance report](https://github.com/bulldog2011/bigqueue/wiki/Performance-Test-Report)

##How to Use
## How to Use
1. Direct jar or source reference
Download jar from the github release section.
***Note*** : bigqueue depends on log4j, please also added log4j jar reference if you use bigqueue.
Expand All @@ -49,7 +49,7 @@ Download jar from the github release section.


##Docs
## Docs

1. [a simple design doc](http://bulldog2011.github.com/blog/2013/01/23/big-queue-design/)
2. [big queue tutorial](http://bulldog2011.github.com/blog/2013/01/24/big-queue-tutorial/)
Expand All @@ -76,7 +76,7 @@ Download jar from the github release section.
* Initial version:)


##Copyright and License
## Copyright and License
Copyright 2012 Leansoft Technology <[email protected]>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this work except in compliance with the License. You may obtain a copy of the License in the LICENSE file, or at:
Expand Down

0 comments on commit 6a8830a

Please sign in to comment.