Skip to content

Commit 1bc6718

Browse files
committed
rename XMLStreamCursor into XMLStreamReader and add asynchronous start to avoid blocking tasks
1 parent a9853ba commit 1bc6718

File tree

15 files changed

+489
-378
lines changed

15 files changed

+489
-378
lines changed

README.md

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,15 @@ The core library provides:
66
* A new IO (Input/Output) model, flexible, and providing asynchronous operations
77

88
It does not have any dependency, however the library [net.lecousin.framework.system](https://github.com/lecousin/java-framework-system "java-framework-system")
9-
is recommended for better performances on disk operations.
10-
11-
It needs to be started by using the net.lecousin.framework.application.Application#start method.
9+
is recommended for better performances on disk operations (detection of physical drives).
1210

1311
## Build status
1412

1513
Current version: 0.8.0
1614

1715
Master: ![build status](https://travis-ci.org/lecousin/java-framework-core.svg?branch=master "Build Status")
1816

19-
Branch 0.8: branch 0.8 ![build status](https://travis-ci.org/lecousin/java-framework-core.svg?branch=0.8 "Build Status")
17+
Branch 0.8: ![build status](https://travis-ci.org/lecousin/java-framework-core.svg?branch=0.8 "Build Status")
2018

2119
Branch 0.9: ![build status](https://travis-ci.org/lecousin/java-framework-core.svg?branch=0.9 "Build Status")
2220

@@ -49,4 +47,26 @@ The model provided by Java is very basic and mainly based on streams (reading or
4947
Our model add two main additions:
5048
* Flexibility by using interfaces that define the capabilities of an Input/Output implementation such as Readable, Writable, Seekable, Resizable, Buffered...
5149
* Asynchronous operations allowing multi-threading
52-
50+
51+
## Startup
52+
53+
To start the framework, one of the _start_ method can be called on the Application class.
54+
This will initialize the environment for a single application.
55+
56+
Once initialized, the application instance can be retrieved through the LCCore.getApplication() method.
57+
58+
Multi-application environment implementations may come in the future, so the framework is designed such
59+
as multiple applications may share the same environment, including the same multi-threading system.
60+
61+
## Logging
62+
63+
A logging system is also provided, in a similar way as other logging frameworks.
64+
TODO
65+
66+
## Memory management
67+
68+
TODO
69+
70+
## Locale
71+
72+
TODO

0 commit comments

Comments
 (0)