File tree Expand file tree Collapse file tree 1 file changed +24
-0
lines changed Expand file tree Collapse file tree 1 file changed +24
-0
lines changed Original file line number Diff line number Diff line change @@ -6,6 +6,30 @@ This repository contains a set of packages for interacting with the [HackMD API]
66
77See [ README] ( ./nodejs )
88
9+ ## Examples
10+
11+ To help you get started quickly, we provide comprehensive usage examples in the ` examples/ ` directory:
12+
13+ ### Node.js Example
14+
15+ The ` examples/nodejs/ ` directory contains a complete example project demonstrating:
16+
17+ - User information retrieval
18+ - Note creation and management
19+ - ETag support for caching
20+ - Content updates
21+ - Error handling with retry logic
22+ - Environment variable configuration
23+
24+ To run the Node.js example:
25+
26+ 1 . Navigate to the example directory: ` cd examples/nodejs `
27+ 2 . Follow the setup instructions in [ examples/nodejs/README.md] ( ./examples/nodejs/README.md )
28+ 3 . Set your HackMD access token
29+ 4 . Run ` npm start `
30+
31+ The example includes detailed comments and demonstrates best practices for using the HackMD API client.
32+
933## LICENSE
1034
1135MIT
You can’t perform that action at this time.
0 commit comments