make:lightning-search

add some docs
modified:   GNUmakefile
modified:   cargo.mk
modified:   examples/lightning_search/src/main.rs
modified:   src/bin/mempool-space_lightning_search.rs

GNUmakefile

@@ -180,6 +180,8 @@ more:## 	more help
 
 .PHONY:docs
 docs:cargo-docs## 	docs
+lightning-search:## 	lightning-search
+	@cargo install --path ./examples/lightning_search
 tests:## 	tests
 	for bin in $$(ls target/release/mempool-space*); do ./$${bin/.d} 2>/dev/null; done
 

cargo.mk

@@ -28,9 +28,10 @@ cargo-build:### 	cargo build
 	@. $(HOME)/.cargo/env
 	@RUST_BACKTRACE=all cargo b $(QUIET)
 cargo-i:cargo-install
-cargo-install:### 	cargo install --path jj
+cargo-install:### 	cargo install --path .
 	@. $(HOME)/.cargo/env
 	@cargo install --path . $(FORCE)
+	@cargo install --path ./examples/lightning_search
 cargo-bench:### 	cargo-bench
 	@. $(HOME)/.cargo/env
 	@cargo bench

examples/lightning_search/src/main.rs

@@ -1,13 +1,16 @@
-use mempool_space::api::{api, blocking};
+//! lightning_search
+//!
+//! use mempool_space::mempool_space_lightning_search::main
+//!
+//! [GET /api/v1/lightning/search?searchText=:query](https://mempool.space/api/v1/lightning/search?searchText=ACINQ)
+//!
+//!	[get-lightning-nodes-channels](https://mempool.space/docs/api/rest#get-lightning-nodes-channels)
+//!
+//!	`curl -sSL "https://mempool.space/api/v1/lightning/search?searchText=ACINQ"`
+
+use mempool_space::api::blocking;
 use std::env;
 
-/// use mempool_space::mempool_space_lightning_search::main
-///
-/// [GET /api/v1/lightning/search?searchText=:query](https://mempool.space/api/v1/lightning/search?searchText=ACINQ)
-///
-///	[get-lightning-nodes-channels](https://mempool.space/docs/api/rest#get-lightning-nodes-channels)
-///
-///	`curl -sSL "https://mempool.space/api/v1/lightning/search?searchText=ACINQ"`
 fn main() {
     {
         let args: Vec<String> = env::args().collect();

src/bin/mempool-space_lightning_search.rs

@@ -1,13 +1,16 @@
+//! lightning_search
+//!
+//! use mempool_space::mempool_space_lightning_search::main
+//!
+//! [GET /api/v1/lightning/search?searchText=:query](https://mempool.space/api/v1/lightning/search?searchText=ACINQ)
+//!
+//!	[get-lightning-nodes-channels](https://mempool.space/docs/api/rest#get-lightning-nodes-channels)
+//!
+//!	`curl -sSL "https://mempool.space/api/v1/lightning/search?searchText=ACINQ"`
+
 use mempool_space::api::blocking;
 use std::env;
 
-/// use mempool_space::mempool_space_lightning_search::main
-///
-/// [GET /api/v1/lightning/search?searchText=:query](https://mempool.space/api/v1/lightning/search?searchText=ACINQ)
-///
-///	[get-lightning-nodes-channels](https://mempool.space/docs/api/rest#get-lightning-nodes-channels)
-///
-///	`curl -sSL "https://mempool.space/api/v1/lightning/search?searchText=ACINQ"`
 fn main() {
     {
         let args: Vec<String> = env::args().collect();