Skip to content

Commit f5e2b09

Browse files
authored
Replace unsupported definition list syntax in README.md (#689)
* Replace unsupported definition list syntax in README.md problem: GitHub Flavored Markdown (GFM) does not support Markdown's definition lists natively. fix: simulate a definition list using bold terms and line breaks * Update README.md * Add line breaks in README.md
1 parent adc9847 commit f5e2b09

File tree

1 file changed

+8
-11
lines changed

1 file changed

+8
-11
lines changed

README.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,20 +18,17 @@ is favored as of now.
1818

1919
#### Features
2020

21-
Safety
22-
: The code you write in a Rust NIF should never be able to crash the BEAM.
21+
**Safety**
22+
The code you write in a Rust NIF should never be able to crash the BEAM.
2323

24-
Interop
25-
: Decoding and encoding rust values into Erlang terms is as easy as a function
26-
: call.
24+
**Interop**
25+
Decoding and encoding rust values into Erlang terms is as easy as a function call.
2726

28-
Type composition
29-
: Making a Rust struct encodable and decodable to Erlang or Elixir can be done
30-
: with a single attribute.
27+
**Type composition**
28+
Making a Rust struct encodable and decodable to Erlang or Elixir can be done with a single attribute.
3129

32-
Resource objects
33-
: Enables you to safely pass a reference to a Rust struct into Erlang code. The
34-
: struct will be automatically dropped when it's no longer referenced.
30+
**Resource objects**
31+
Enables you to safely pass a reference to a Rust struct into Erlang code. The struct will be automatically dropped when it's no longer referenced.
3532

3633
#### Getting started
3734

0 commit comments

Comments
 (0)