Skip to content

Commit c4f1856

Browse files
author
Konstantin Ivaschenko
committed
update README.md
1 parent 5fa71a7 commit c4f1856

File tree

2 files changed

+63
-32
lines changed

2 files changed

+63
-32
lines changed

README.md

Lines changed: 62 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -410,45 +410,75 @@ sudo /usr/bin/xattr -r -d com.apple.quarantine <directory_with_tools>
410410

411411
## Samples
412412

413-
- [x] [ConvertTapeFileSample](samples/File/ConvertTapeFileSample)
414-
demonstrates how to convert one tape file to another tape file with optional intermediate processing or filtering
415-
- [x] [FileParserSample](samples/File/FileParserSample)
416-
is a simple demonstration of how events are read form a tape file
417-
- [x] [QuoteAndTradeSample](samples/API/QuoteAndTradeSample)
418-
is a simple demonstration of how to create multiple event listeners and subscribe to `Quote` and `Trade` events
413+
### API
414+
415+
- [x] [AuthSample](samples/API/AuthSample)
416+
demonstrates how to connect to an endpoint that requires an authentication token,
417+
subscribe to market data events, and handle periodic token updates.
418+
- [x] [ConnectSample](samples/API/ConnectSample)
419+
demonstrates how to connect to the endpoint and subscribe to various market events.
419420
- [x] [PrintQuoteEventsSample](samples/API/PrintQuoteEventsSample)
420-
is a simple demonstration of how to subscribe to the `Quote` event, using a `DxFeed` instance singleton
421-
and `dxfeed.system.properties` file
422-
- [x] [WriteTapeFileSample](samples/File/WriteTapeFileSample)
423-
is a simple demonstration of how to write events to a tape file
424-
- [x] [IpfSample](samples/IPF/IpfSample) is a simple
425-
demonstration of how to get Instrument Profiles
426-
- [x] [IpfLiveSample](samples/IPF/IpfLiveSample) is a
427-
simple demonstration of how to get live updates for Instrument Profiles
428-
- [x] [ScheduleSample](samples/Schedule/ScheduleSample) is a simple
429-
demonstration of how to get various scheduling information for instruments
430-
- [x] [FetchDailyCandlesSample](samples/Candle/FetchDailyCandlesSample)
431-
is a simple demonstration of how to fetch last N-days of candles for a specified symbol
421+
demonstrates how to subscribe to the `Quote` event, using a `DxFeed` instance singleton
422+
and `dxfeed.system.properties` file.
423+
- [x] [QuoteAndTradeSample](samples/API/QuoteAndTradeSample)
424+
demonstrates how to create multiple event listeners and subscribe to `Quote` and `Trade` events.
432425
- [x] [ReconnectSample](samples/API/ReconnectSample)
433-
is a simple demonstration of how to connect to an endpoint, subscribe to market data events, handle reconnections
426+
demonstrates how to connect to an endpoint, subscribe to market data events, handle reconnections
434427
and re-subscribing.
428+
429+
### Candle
430+
431+
- [x] [CandleSample](samples/Candle/CandleSample)
432+
demonstrates how to subscribe to `Candle` events.
435433
- [x] [CandleDataSample](samples/Candle/CandleDataSample)
436-
is a simple demonstration of how to parse response from CandleData service.
437-
- [x] [MarketDepthModelSample](samples/UI/MarketDepthModelSample)
438-
is a simple demonstration of how to draw a Market Depth using Avalonia UI.
439-
- [x] [CandleChartSample](samples/UI/CandleChartSample)
440-
is a simple demonstration of how to draw a Candlestick Chart using Avalonia UI.
441-
- [x] [IncOrderSnapshotSample](samples/Model/IncOrderSnapshotSample)
442-
is a simple demonstration of how to subscribe to the Order event and handle snapshots and updates.
443-
- [x] [MultipleMarketDepthSample](samples/Model/MultipleMarketDepthSample)
444-
is a simple demonstration of how to use the `MarketDepthModel` to manage and display order books for multiple symbols.
445-
- [x] [OptionChainSample](samples/IPF/OptionChainSample)
446-
how to build option chains, and prints quotes for nearby option strikes.
434+
demonstrates how to parse response from CandleData service.
435+
- [x] [FetchDailyCandlesSample](samples/Candle/FetchDailyCandlesSample)
436+
demonstrates how to fetch last N-days of candles for a specified symbol.
437+
438+
### Console
439+
447440
- [x] [LastEventConsoleSample](samples/Console/LastEventConsoleSample)
448-
is a simple demonstration how to subscribe to various market events with the dxFeed API, cache them in memory, and
441+
demonstrates how to subscribe to various market events with the dxFeed API, cache them in memory, and
449442
take snapshots of these events based on user input.
443+
444+
### File
445+
446+
- [x] [ConvertTapeFileSample](samples/File/ConvertTapeFileSample)
447+
demonstrates how to convert one tape file to another tape file with optional intermediate processing or filtering.
448+
- [x] [FileParserSample](samples/File/FileParserSample)
449+
demonstrates how to read events from a tape file.
450+
- [x] [WriteTapeFileSample](samples/File/WriteTapeFileSample)
451+
demonstrates how to write events to a tape file.
452+
453+
### IPF
454+
455+
- [x] [IpfSample](samples/IPF/IpfSample)
456+
demonstrates how to get Instrument Profiles.
457+
- [x] [IpfLiveSample](samples/IPF/IpfLiveSample)
458+
demonstrates how to get live updates for Instrument Profiles.
459+
- [x] [OptionChainSample](samples/IPF/OptionChainSample)
460+
demonstrates how to build option chains, and prints quotes for nearby option strikes.
461+
462+
### Model
463+
464+
- [x] [IncOrderSnapshotSample](samples/Model/IncOrderSnapshotSample)
465+
demonstrates how to subscribe to the Order event and handle snapshots and updates.
466+
- [x] [MultipleMarketDepthSample](samples/Model/MultipleMarketDepthSample)
467+
demonstrates how to use the `MarketDepthModel` to manage and display order books for multiple symbols.
468+
469+
### Schedule
470+
471+
- [x] [ScheduleSample](samples/Schedule/ScheduleSample)
472+
demonstrates how to get various scheduling information for instruments.
473+
474+
### UI
475+
476+
- [x] [MarketDepthModelSample](samples/UI/MarketDepthModelSample)
477+
demonstrates how to draw a Market Depth using Avalonia UI.
478+
- [x] [CandleChartSample](samples/UI/CandleChartSample)
479+
demonstrates how to draw a Candlestick Chart using Avalonia UI.
450480
- [x] [PriceLevelBookSample](samples/UI/PriceLevelBookSample)
451-
is a simple demonstration of how to represent a price level book (market by price) that aggregates individual orders
481+
demonstrates how to compile a price level book (market by price) that aggregates individual orders
452482
(market by order).
453483

454484
## Current State

ReleaseNotes.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
* [MDAPI-121] [.NET] Publish samples with the release
12
* [MDAPI-123] [.NET] Add the ability to set Java System Properties
23
- Now any Java Properties can be set either through setting environment variables
34
or using the dxfeed.system.properties file

0 commit comments

Comments
 (0)