Skip to content

Commit daae5da

Browse files
committed
Format markdown
1 parent 35bd282 commit daae5da

File tree

3 files changed

+33
-25
lines changed

3 files changed

+33
-25
lines changed

CHANGELOG.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
# Changelog
2+
23
All notable changes to this project will be documented in this file.
34

45
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
56
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
67

78
## \[Unreleased]
8-
- Initial implementation of 1.0 and 2.0 server
9-
- Initial implementation of 1.0 and 2.0 client
10-
- Test suite for server and client
9+
10+
- Initial implementation of 1.0 and 2.0 server
11+
- Initial implementation of 1.0 and 2.0 client
12+
- Test suite for server and client

CONTRIBUTING.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
# Code style
2-
Please make sure your editor picks up the [.clang-format](.clang-format) file.
2+
3+
Please make sure your editor picks up the [.clang-format](.clang-format) file.

README.md

Lines changed: 26 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,46 +6,51 @@
66
[![CircleCI](https://circleci.com/gh/jsonrpcx/json-rpc-cxx.svg?style=svg)](https://circleci.com/gh/jsonrpcx/json-rpc-cxx)
77
[![codecov](https://codecov.io/gh/jsonrpcx/json-rpc-cxx/branch/master/graph/badge.svg)](https://codecov.io/gh/jsonrpcx/json-rpc-cxx)
88

9-
109
![json-rpc-cxx-icon](doc/icon.png)
1110

1211
A [JSON-RPC](https://www.jsonrpc.org/) (1.0 & 2.0) framework implemented in C++17 using the [nlohmann's json for modern C++](https://github.com/nlohmann/json).
1312

14-
- JSON-RPC 1.0 and 2.0 compliant client
15-
- JSON-RCP 1.0 and 2.0 compliant server
16-
- Transport agnostic interfaces
17-
- Compile time type mapping (using [nlohmann's arbitrary type conversion](https://github.com/nlohmann/json#arbitrary-types-conversions))
18-
- Runtime type checking
19-
- Cross-platform (Windows, Linux, OSX)
13+
- JSON-RPC 1.0 and 2.0 compliant client
14+
- JSON-RCP 1.0 and 2.0 compliant server
15+
- Transport agnostic interfaces
16+
- Compile time type mapping (using [nlohmann's arbitrary type conversion](https://github.com/nlohmann/json#arbitrary-types-conversions))
17+
- Runtime type checking
18+
- Cross-platform (Windows, Linux, OSX)
2019

2120
## Installation
22-
- Copy [include/jsonrpccxx](include) to your include path
23-
- Alternatively use CMake install mechanism
21+
22+
- Copy [include/jsonrpccxx](include) to your include path
23+
- Alternatively use CMake install mechanism
24+
2425
```bash
2526
mkdir build && cd build
2627
cmake ..
2728
sudo make install
2829
```
2930

30-
3131
## Usage
32-
- [examples/warehouse/main.cpp](examples/warehouse/main.cpp)
32+
33+
- [examples/warehouse/main.cpp](examples/warehouse/main.cpp)
3334

3435
## Design goals
35-
- Easy to use interface
36-
- Type safety where possible
37-
- Avoid errors at compile time where possible
38-
- Test driven development
39-
- Choose expressiveness over speed
40-
- Minimal dependencies
36+
37+
- Easy to use interface
38+
- Type safety where possible
39+
- Avoid errors at compile time where possible
40+
- Test driven development
41+
- Choose expressiveness over speed
42+
- Minimal dependencies
4143

4244
## License
45+
4346
This framework is licensed under [MIT](LICENSE).
4447

4548
### Dependencies
46-
- [nlohmann's JSON for modern C++](https://github.com/nlohmann/json) is licensed under MIT.
47-
- [Catch](https://github.com/catchorg/Catch2) is licensed under BSL-1.0.
49+
50+
- [nlohmann's JSON for modern C++](https://github.com/nlohmann/json) is licensed under MIT.
51+
- [Catch](https://github.com/catchorg/Catch2) is licensed under BSL-1.0.
4852

4953
## Developer information
50-
- [CONTRIBUTING.md](CONTRIBUTING.md)
51-
- [CHANGELOG.md](CHANGELOG.md)
54+
55+
- [CONTRIBUTING.md](CONTRIBUTING.md)
56+
- [CHANGELOG.md](CHANGELOG.md)

0 commit comments

Comments
 (0)