Skip to content

Commit a925c88

Browse files
update readme with the org style
Signed-off-by: Vincenzo Palazzo <[email protected]>
1 parent 97f408a commit a925c88

File tree

1 file changed

+73
-17
lines changed

1 file changed

+73
-17
lines changed

README.md

+73-17
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,42 @@
1-
# Lamp
2-
<strong> [c-Lightning](https://github.com/ElementsProject/lightning) Android Mobile Porting </strong>
3-
4-
[![build](https://github.com/clightning4j/lamp/workflows/android-master/badge.svg)](https://github.com/clightning4j/lamp/actions)
5-
[![release](https://github.com/clightning4j/lamp/workflows/release/badge.svg)](https://github.com/clightning4j/lamp/actions)
6-
[![MIT license](https://img.shields.io/github/license/clightning4j/lamp)](https://github.com/clightning4j/lamp/blob/master/LICENSE)
7-
1+
<div align="center">
2+
<h1>:bulb: Lamp :zap:</h1>
3+
4+
<img src="https://github.com/clightning4j/icons/blob/main/lamp_app/android/res/mipmap-xxxhdpi/ic_launcher.png" />
5+
6+
<p>
7+
<strong> :bulb: <a href="https://github.com/ElementsProject/lightning">c-lightning</a> Android Mobile Porting :zap: </strong>
8+
</p>
9+
10+
<p>
11+
<a href="https://github.com/clightning4j/lamp/actions">
12+
<img alt="GitHub Workflow Status (branch)" src="https://img.shields.io/github/workflow/status/clightning4j/lamp/android-master/master?style=flat-square">
13+
</a>
14+
<a href="https://github.com/clightning4j/lamp/releases">
15+
<img alt="GitHub release (latest SemVer)" src="https://img.shields.io/github/v/release/clightning4j/lamp?style=flat-square">
16+
</a>
17+
<img alt="GitHub all releases" src="https://img.shields.io/github/downloads/clightning4j/lamp/total?style=flat-square">
18+
<a href="https://github.com/clightning4j/lamp/blob/master/LICENSE">
19+
<img alt="GitHub" src="https://img.shields.io/github/license/clightning4j/lamp?style=flat-square">
20+
</a>
21+
</p>
22+
23+
<p>
24+
<a href="https://apt.izzysoft.de/fdroid/index/apk/com.lvaccaro.lamp">
25+
<img src="https://gitlab.com/IzzyOnDroid/repo/-/raw/master/assets/IzzyOnDroid.png" width="200" height="80" />
26+
</a>
27+
</p>
28+
</div>
29+
30+
## Table of Content
31+
32+
- Introduction
33+
- How to Use
34+
- Build
35+
- How to Contribute
36+
- References
37+
- License
38+
39+
## Introduction
840

941
> This is an experimenting lightning wallet. Use it on testnet or only with amounts you can afford to lose on mainnet.
1042
@@ -16,9 +48,11 @@ Touch the lamp to download and run c-lightning from cross-compiled binaries for
1648
<img src="doc/img/Screen3.png" width="230" height="350" />
1749
</span>
1850

19-
## Bitcoin Setup
51+
## How to Use
52+
53+
### Bitcoin Setup
2054

21-
#### Automatic with esplora plugin
55+
##### Automatic with esplora plugin
2256

2357
This is the default behaviour.
2458

@@ -27,21 +61,21 @@ Lamp is using [the C Esplora plugin for C-lightning](https://github.com/clightni
2761
You can point it to your own [Esplora](github.com/Blockstream/esplora) instance in the settings, and it uses [blockstream.info](https://blockstream.info) by default.
2862

2963

30-
#### Manually with bitcoind rpc node
64+
##### Manually with bitcoind rpc node
3165
On Lamp settings, disable Esplora plugin and set the current Bitcoin RPC options:
3266

3367
- Bitcoin RPC username
3468
- Bitcoin RPC password
3569
- Bitcoin RPC host (default 127.0.0.1)
3670
- Bitcoin RPC port (default 18332 for testnet)
3771

38-
## Tor Setup
72+
### Tor Setup
3973

40-
#### Automatic with internal tor service
74+
##### Automatic with internal tor service
4175

4276
Lamp is using tor hidden service as default. A new hidden service will be created at the first running time.
4377

44-
#### Manually with Orbot
78+
##### Manually with Orbot
4579

4680
Open [Orbot](https://github.com/guardianproject/Orbot) and setup a fixed tor address by menu: Onion Services -> Hosted Services -> set a service name and port 9735. Restarting tor to discover and copy the local address.
4781

@@ -56,13 +90,12 @@ Read the following instructions at [Tor on clightning](https://lightning.readthe
5690
## Building
5791

5892
* [in Linux using cmdline tools](doc/cmdline-tools-setup.md)
59-
60-
## Store Supported
61-
[<img src="https://gitlab.com/IzzyOnDroid/repo/-/raw/master/assets/IzzyOnDroid.png" width="200" height="80" />](https://apt.izzysoft.de/fdroid/index/apk/com.lvaccaro.lamp)
6293

94+
## How to Contribute
6395

96+
Just propose new stuff to add or bug fixing with a new PR.
6497

65-
## Code Style
98+
### Code Style
6699
[![ktlint](https://img.shields.io/badge/code%20style-%E2%9D%A4-FF4081.svg)](https://ktlint.github.io/)
67100

68101
> We live in a world where robots can drive a car, so we shouldn't just write code, we should write elegant code.
@@ -81,3 +114,26 @@ before submit the code check the Kotlin format with the following command on the
81114
- [clightning_ndk](https://github.com/clightning4j/lightning_ndk) android cross-compilation of c-lightning for Android >= 24 Api
82115
- [c-lightning](https://github.com/ElementsProject/lightning) Lightning Network implementation in C
83116
- [esplora plugin](https://github.com/clightning4j/esplora_clnd_plugin) C-Lightning plugin for esplora
117+
118+
## License
119+
120+
<div align="center">
121+
<img src="https://opensource.org/files/osi_keyhole_300X300_90ppi_0.png" width="150" height="150"/>
122+
</div>
123+
124+
c-lightning Android Mobile Porting
125+
126+
Copyright (c) 2019-2021 Luca Vaccaro
127+
128+
This program is free software; you can redistribute it and/or modify
129+
it under the terms of the GNU General Public License as published by
130+
the Free Software Foundation; either version 2 of the License.
131+
132+
This program is distributed in the hope that it will be useful,
133+
but WITHOUT ANY WARRANTY; without even the implied warranty of
134+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
135+
GNU General Public License for more details.
136+
137+
You should have received a copy of the GNU General Public License along
138+
with this program; if not, write to the Free Software Foundation, Inc.,
139+
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

0 commit comments

Comments
 (0)