Skip to content

Commit e75f073

Browse files
committed
update the README
1 parent c3911c2 commit e75f073

File tree

1 file changed

+46
-3
lines changed

1 file changed

+46
-3
lines changed

README.md

Lines changed: 46 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,64 @@
1+
# TS-Blockchain
2+
13
[![TypeScript version][ts-badge]][typescript-34]
24
[![Node.js version][nodejs-badge]][nodejs]
35
[![APLv2][license-badge]][license]
46

57
[![Donate][donate-badge]][donate]
68
[![Donate][donate-badge2]][donate2]
79

8-
# Minimalistic blockchain written with TypeScript
10+
> A minimalistic blockchain written with Node.js + Express using TypeScript as the base programming language.
911
1012
## Features
1113

14+
- A minimalistic blockchain
15+
- P2P
16+
- Proof of Work with mining
17+
- With wallets and transactions
18+
- NodeJS & Express
1219
- TypeScript 3.4
13-
- Custom errors
1420

15-
## Credits
21+
## Endpoints
22+
23+
```http
24+
GET /blocks
25+
POST /mine
26+
GET /transactions
27+
POST /transact
28+
GET /mine-transactions
29+
GET /public-key
30+
```
31+
32+
## Testing
33+
34+
The tests are written with Jest
35+
36+
```json
37+
"jest": "24.7.1",
38+
"ts-jest": "24.0.2",
39+
"@types/jest": "24.0.11",
40+
```
41+
42+
## The road to v1
43+
44+
- Build a smart-contract engine
45+
- Add data persitance
46+
- ... maybe a system of plugins
47+
48+
## Credits & Inspirations
1649

1750
- [Node TypeScript Boilerplate](https://github.com/jsynowiec/node-typescript-boilerplate/blob/master/package.json)
1851

52+
# MIT License
53+
54+
Copyright (c) 2019 Philippe Matray
55+
56+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
57+
58+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
59+
60+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
61+
1962
[ts-badge]: https://img.shields.io/badge/TypeScript-3.4-blue.svg
2063
[typescript-34]: https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-4.html
2164
[nodejs-badge]: https://img.shields.io/badge/Node.js->=%2010.13-blue.svg

0 commit comments

Comments
 (0)