mirror of
https://github.com/ElementsProject/lightning.git
synced 2025-03-04 19:16:23 +01:00
e83782f5de
This PR: - adds all the guides (in markdown format) that is published at https://docs.corelightning.org/docs - adds a github workflow to sync any future changes made to files inside the guides folder - does not include API reference (json-rpc commands). Those will be handled in a separate PR since they're used as manpages and will require a different github workflow Note that the guides do not exactly map to their related files in doc/, since we reorganized the overall documentation structure on readme for better readability and developer experience. For example, doc/FUZZING.md and doc/HACKING.md#Testing are merged into testing.md in the new docs. As on the creation date of this PR, content from each of the legacy documents has been synced with the new docs. Until this PR gets merged, I will continue to push any updates made to the legacy documents into the new docs. If this looks reasonable, I will add a separate PR to clean up the legacy documents from doc/ (or mark them deprecated) to avoid redundant upkeep and maintenance. Changelog-None
1.4 KiB
1.4 KiB
| title | slug | excerpt | hidden | createdAt | updatedAt |
|---|---|---|---|---|---|
| App Development | app-development | Build a lightning application using Core Lightning APIs. | false | 2022-12-09T09:56:04.704Z | 2023-02-21T13:48:15.261Z |
There are several ways to connect and interact with a Core Lightning node in order to build a lightning app or integrate lightning in your application.
- Using **JSON-RPC commands **if you're building an application in the same system as the CLN node.
- Using gRPC APIs if you're building an application in a remote client and want to connect to the CLN node over a secure network.
- Using Commando to connect to a CLN node over the lightning network and issue commands.
- Third-party libraries that offer REST, GraphQL or JSON over HTTPS frameworks to connect to a CLN node remotely.
[block:image] { "images": [ { "image": [ "https://files.readme.io/b8d50a6-cln-api.png", null, "A visual chart of all interface and transport protocols to interact with a CLN node." ], "align": "center", "border": true, "caption": "A visual chart of available API interfaces and transport protocols for interacting with a CLN node" } ] } [/block]
