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

add readme to plugins #1319

Merged
merged 7 commits into from
Sep 19, 2018
Merged

add readme to plugins #1319

Changes from 6 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
8a25c3c
add readme to plugins
oxarbitrage Sep 11, 2018
52279ae
change hashtag to link
oxarbitrage Sep 14, 2018
0a3c1e2
add space id column
oxarbitrage Sep 14, 2018
ea6d6cd
join space and id in 1 word to make the table look better
oxarbitrage Sep 14, 2018
a613e44
sort plugins alphabetically
oxarbitrage Sep 14, 2018
a387f9b
fix account history space id
oxarbitrage Sep 14, 2018
8664e87
fix english syntax
oxarbitrage Sep 17, 2018
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
21 changes: 21 additions & 0 deletions libraries/plugins/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# BitShares Plugins

The bitshares plugins are a collection of tools that brings new functionality without the need of modifications in the consensus and more sensitive areas of the bitshares-core.

The main source of I/O of the bitshares blockchain is the API. Plugins are a more powerful alternative to build more complex developments for when the current API is not enough.

Plugins are optional to run by node operator according to their needs however all plugins here will be compiled. There are plans for optional build of plugins at: [Issue 533](https://github.com/bitshares/bitshares-core/issues/533)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

... to their needs. However, ...


# Available Plugins

Folder | Name | Description | Category | Status | SpaceID
-----------------------------------|--------------------------|-----------------------------------------------------------------------------|----------------|---------------|--------------|
[account_history](account_history) | Account History | Save account history data | History | Stable | 4
[debug_witness](debug_witness) | Debug Witness | Run "what-if" tests | Debug | Stable |
[delayed_node](delayed_node) | Delayed Node | Avoid forks by running a several times confirmed and delayed blockchain | Business | Stable |
[elasticsearch](elasticsearch) | ElasticSearch Operations | Save account history data into elasticsearch database | History | Experimental | 6
[es_objects](es_objects) | ElasticSearch Objects | Save selected objects into elasticsearch database | History | Experimental |
[grouped_orders](grouped_orders) | Grouped Orders | Expose api to create a grouped order book of bitshares markets | Market data | Experimental |
[market_history](market_history) | Market History | Save market history data | Market data | Stable | 5
[snapshot](snapshot) | Snapshot | Get a json of all objects in blockchain at a specificed time or block | Debug | Stable |
[witness](witness) | Witness | Generate and sign blocks | Block producer | Stable |