Skip to content

Commit

Permalink
chore(release): bump version to v1.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
jamaljsr committed Mar 25, 2020
1 parent 1dbadc2 commit 412662d
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 11 deletions.
45 changes: 42 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,46 @@

All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.

## [0.2.1](https://github.com/jamaljsr/polar/compare/v0.2.0...v0.2.1)
## [v1.0.0](https://github.com/jamaljsr/polar/compare/v0.2.1...v1.0.0)

This release was focused on implementing many of the feature requests submitted since the first release, as well as adding support for the Eclair Lightning implementation. You can now use your own custom Docker image, allowing you to run the master branch or your personal fork of each node. Polar now supports importing and exporting networks, which allows you to save snapshots to reuse as a starting point over an over again. We also added a log viewer for nodes which should make it easier to see what your nodes are doing and added right-click menus for nodes & channels so you can perform actions with less clicks. To support more flexible environments, the Lightning P2P and Bitcoin ZMQ ports are now exposed to the host machine, which means you can have nodes outside of Polar communicate with the nodes inside.

I am bumping the version to a major release v1.0.0 to signify that I feel Polar is now pretty stable and fully-functional, with support for the big three Lightning implementations. There are still more improvements which will be added in the future, but what's included now is a solid base.

### Features

- Add support for Eclair v0.3.3 nodes ([#322](https://github.com/jamaljsr/polar/pull/322))
- Add ability to import & export networks ([#295](https://github.com/jamaljsr/polar/pull/295)) by [@torkelrogstad](https://github.com/torkelrogstad)
- Add support for custom docker images ([#299](https://github.com/jamaljsr/polar/pull/299))
- Make bitcoind's ZeroMQ servers reachable on LAN ([#297](https://github.com/jamaljsr/polar/pull/297)) by [@hsjoberg](https://github.com/hsjoberg)
- Make lightning nodes p2p port reachable on LAN ([#301](https://github.com/jamaljsr/polar/pull/301)) by [@hsjoberg](https://github.com/hsjoberg)
- Add right-click menus for nodes and channels ([#312](https://github.com/jamaljsr/polar/pull/312))
- Add ability to view live logs from nodes ([#316](https://github.com/jamaljsr/polar/pull/316))

### Bug Fixes

- Handle errors in Bitcoind logger ([#285](https://github.com/jamaljsr/polar/pull/285)) by [@bolatovumar](https://github.com/bolatovumar)
- Make sure localBalance is never undefined for pending channel ([#289](https://github.com/jamaljsr/polar/pull/289)) by [@bolatovumar](https://github.com/bolatovumar)
- Fix corrupt redux state causing errors ([#305](https://github.com/jamaljsr/polar/pull/305))
- Fix broken line wrapping for long commands in the terminal ([#310](https://github.com/jamaljsr/polar/pull/310))
- Fix typo in English translations ([#323](https://github.com/jamaljsr/polar/pull/323))

### Docs

- Add CONTRIBUTING documentation ([#294](https://github.com/jamaljsr/polar/pull/294))
- Add documentation for building custom node images ([custom-node.md](https://github.com/jamaljsr/polar/blob/master/docs/custom-nodes.md))

### Community Contributions

Polar received contributions from a few community members. I'd like to sincerely thank these devs for giving back to the project.

- Torkel Rogstad [@torkelrogstad](https://github.com/torkelrogstad)
- Hampus Sjöberg [@hsjoberg](https://github.com/hsjoberg)
- Umar Bolatov [@bolatovumar](https://github.com/bolatovumar)

All feedback and contributions are greatly appreciated.

## [v0.2.1](https://github.com/jamaljsr/polar/compare/v0.2.0...v0.2.1)

This is just a small release to bring back light mode for those who prefer it over dark mode.

Expand All @@ -18,7 +57,7 @@ This is just a small release to bring back light mode for those who prefer it ov

- fix spelling and add Polar version field to bug template ([#279](https://github.com/jamaljsr/polar/pull/279)) h/t [@bolatovumar](https://github.com/bolatovumar)

## [0.2.0](https://github.com/jamaljsr/polar/compare/v0.1.0...v0.2.0)
## [v0.2.0](https://github.com/jamaljsr/polar/compare/v0.1.0...v0.2.0)

This release was focused on adding core features that didn't make it in the first release, as well as some UX and stability improvements. The UI has been redesigned to use a dark theme which has been a popular request. Polar now supports the latest versions of LND v0.8.2, Bitcoin Core v0.19.0.1 and adds support for c-lightning v0.8.0. Future released versions of these Lightning & Bitcoin nodes can now be used without needing to release a new version of Polar. This feature will let you start using the new versions as soon as they are out. To maintain support for older LND versions which are not compatible with the latest bitcoind, Polar now supports running multiple bitcoin nodes in a single network. Have fun creating chain splits and block reorgs with the new ability to stop and start individual nodes as well :)

Expand Down Expand Up @@ -76,7 +115,7 @@ Polar received contributions from a few community members. I'd like to sincerely

All feedback and contributions are greatly appreciated.

## 0.1.0
## v0.1.0

### First Release

Expand Down
18 changes: 11 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
[![Actions Status](https://github.com/jamaljsr/polar/workflows/CI/badge.svg)](https://github.com/jamaljsr/polar/actions)
[![codecov](https://codecov.io/gh/jamaljsr/polar/branch/master/graph/badge.svg)](https://codecov.io/gh/jamaljsr/polar)
[![Crowdin](https://badges.crowdin.net/polar/localized.svg)](https://crowdin.com/project/polar)
[![GitHub license](https://img.shields.io/github/license/jamaljsr/polar.svg)](https://github.com/jamaljsr/polar/blob/master/LICENSE)
[![GitHub release](https://img.shields.io/github/release/jamaljsr/polar.svg)](https://GitHub.com/jamaljsr/polar/releases/)

<p align="center">
<img src="./assets/screen.png" />
Expand All @@ -26,16 +28,18 @@ With Polar you can:
- Open & Close Channels
- Create & Pay Lightning Invoices
- Launch a terminal in each bitcoin/lightning node
- View streaming logs from each node
- Manually mine new blocks
- Deposit regtest coins into each Lightning node
- Export and import networks, for sharing with other Lightning developers
- Create you own docker images to use as [custom nodes](https://github.com/jamaljsr/polar/blob/master/docs/custom-nodes.md) (ex: master branch, local fork)

Supported Network Node Versions:

- LND v0.8.2, v0.8.0 & v0.7.1
- Bitcoin Core v0.19.0.1 & v0.18.1
- LND v0.9.1, v0.9.0, v0.8.2, v0.8.0 & v0.7.1
- c-lightning v0.8.1 & v0.8.0
- eclair (coming soon?) \*need to gauge demand for this implementation\*
- Eclair v0.3.3
- Bitcoin Core v0.19.1, v0.19.0.1 & v0.18.1

## Dependencies

Expand All @@ -48,11 +52,11 @@ You will be prompted to install Docker if Polar cannot detect it automatically

## Download

Download Polar v0.2.1 for
Download Polar v1.0.0 for your OS

- Mac ([dmg](https://github.com/jamaljsr/polar/releases/download/v0.2.1/polar-mac-v0.2.1.dmg), [zip](https://github.com/jamaljsr/polar/releases/download/v0.2.1/polar-mac-v0.2.1.zip))
- Linux ([deb](https://github.com/jamaljsr/polar/releases/download/v0.2.1/polar-linux-amd64-v0.2.1.deb), [AppImage](https://github.com/jamaljsr/polar/releases/download/v0.2.1/polar-linux-x86_64-v0.2.1.AppImage))
- Windows ([exe](https://github.com/jamaljsr/polar/releases/download/v0.2.1/polar-win-v0.2.1.exe))
- Mac ([dmg](https://github.com/jamaljsr/polar/releases/download/v1.0.0/polar-mac-v1.0.0.dmg), [zip](https://github.com/jamaljsr/polar/releases/download/v1.0.0/polar-mac-v1.0.0.zip))
- Linux ([deb](https://github.com/jamaljsr/polar/releases/download/v1.0.0/polar-linux-amd64-v1.0.0.deb), [AppImage](https://github.com/jamaljsr/polar/releases/download/v1.0.0/polar-linux-x86_64-v1.0.0.AppImage))
- Windows ([exe](https://github.com/jamaljsr/polar/releases/download/v1.0.0/polar-win-v1.0.0.exe))

Alternative and older version binaries can be found in the [GitHub releases](https://github.com/jamaljsr/polar/releases)

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "polar",
"version": "0.2.1",
"version": "1.0.0",
"homepage": "https://lightningpolar.com",
"description": "One-click Bitcoin Lightning networks for local app development & testing",
"author": {
Expand Down

0 comments on commit 412662d

Please sign in to comment.