Skip to content

Commit 72ec9f8

Browse files
cpl121brancoder
andauthored
feat: update readme (#75)
* feat: update readmes * feat: remove handbook * feat: remove more firefly references --------- Co-authored-by: Branko Bosnic <[email protected]>
1 parent 4aecd5f commit 72ec9f8

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+32
-2663
lines changed

.github/CONTRIBUTING.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Contribute to Firefly
1+
# Contribute to Legacy Migration Tool
22

3-
This document describes how to contribute to Firefly.
3+
This document describes how to contribute to Legacy Migration Tool.
44
We encourage everyone with knowledge and passion in IOTA technology to do so.
55

66
Thanks! :heart:
@@ -149,11 +149,11 @@ example that compiles and passes [documentation tests](https://doc.rust-lang.org
149149

150150
- All instances of `unsafe` should have a comment that explains why its use was unavoidable
151151

152-
- All code should be well formatted and linted, passing our [linting continuous integration](https://github.com/iotaledger/firefly/blob/develop/.github/workflows/ci.lint.yml) workflow
152+
- All code should be well formatted and linted, passing our [linting continuous integration](https://github.com/iotaledger/legacy-migration-tool/blob/develop/.github/workflows/ci.lint.yml) workflow
153153

154-
- All code should be well tested, passing (unit _and_ integration tests) both locally and in our [testing continuous integration](https://github.com/iotaledger/firefly/blob/develop/.github/workflows/ci.test.yml) workflow
154+
- All code should be well tested, passing (unit _and_ integration tests) both locally and in our [testing continuous integration](https://github.com/iotaledger/legacy-migration-tool/blob/develop/.github/workflows/ci.test.yml) workflow
155155

156-
- If your changes include modification or adding of dependencies, once your PR is approved it must then be merged into a `snyk/branch-prefix/branch-name` on the main Firefly repository to test said changes with the [Snyk continuous integration](https://github.com/iotaledger/firefly/blob/develop/.github/workflows/ci.snyk.yml) workflow
156+
- If your changes include modification or adding of dependencies, once your PR is approved it must then be merged into a `snyk/branch-prefix/branch-name` on the main Legacy Migration Tool repository to test said changes with the [Snyk continuous integration](https://github.com/iotaledger/legacy-migration-tool/blob/develop/.github/workflows/ci.snyk.yml) workflow
157157

158158
- To be compatible with the guidelines of the Eclipse foundation, all code must be licensed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0). This license must be referenced in every crate of the workspace (add [`./LICENSE`] to the crate's top level directory). For Rust crates, every `Cargo.toml` must contain the line `license = "Apache-2.0"`.
159159

.github/workflows/add-bugs-to-project.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ jobs:
1111
runs-on: ubuntu-latest
1212
name: Assign bug issue to Bug Management project
1313
steps:
14-
- name: Assign issues with bug report label to Firefly - Bug Management project
14+
- name: Assign issues with bug report label to Legacy Migration Tool - Bug Management project
1515
uses: srggrs/assign-one-project-github-action@4fc2b23bdaaac08e64dcc590a6e138d2f9b8c86e
1616
if: contains(github.event.issue.labels.*.name, 'bug report')
1717
with:
18-
project: 'https://github.com/iotaledger/firefly/projects/1'
18+
project: 'https://github.com/iotaledger/legacy-migration-tool/projects/1'
1919
column_name: 'Needs triage'

.github/workflows/ci.snyk.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ on:
88

99
jobs:
1010
test:
11-
# Only run on push events or PRs from iotaledger/firefly, skip on PRs from forks
11+
# Only run on push events or PRs from iotaledger/legacy-migration-tool, skip on PRs from forks
1212
# Secret variables cannot be exposed to PRs from forks
1313
if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository
1414
runs-on: ubuntu-20.04

.github/workflows/handbook.yml

Lines changed: 0 additions & 21 deletions
This file was deleted.

README.md

Lines changed: 8 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,9 @@
1-
<h1 align="center">
2-
<br>
3-
<a href=""><img src="header.png"></a>
4-
</h1>
5-
6-
<h2 align="center">IOTA's wallet</h2>
1+
<h2 align="center">Legacy Migration Tool</h2>
72

83
<p align="center">
94
<a href="https://discord.iota.org/" style="text-decoration:none;"><img src="https://img.shields.io/badge/Discord-9cf.svg?logo=discord" alt="Discord"></a>
105
<a href="https://iota.stackexchange.com/" style="text-decoration:none;"><img src="https://img.shields.io/badge/StackExchange-9cf.svg?logo=stackexchange" alt="StackExchange"></a>
11-
</p>
12-
13-
<p align="center">
14-
<a href="https://github.com/iotaledger/firefly/actions/workflows/ci.test.yml" style="text-decoration:none;"><img src="https://github.com/iotaledger/firefly/actions/workflows/ci.test.yml/badge.svg?branch=develop&event=push" alt="Firefly test CI"></a>
15-
<a href="https://github.com/iotaledger/firefly/blob/develop/LICENSE" style="text-decoration:none;"><img src="https://img.shields.io/badge/License-Apache%202.0-green.svg" alt="Apache 2.0 license"></a>
16-
<a href="https://app.fossa.com/projects/git%2Bgithub.com%2Fiotaledger%2Ffirefly?ref=badge_shield" alt="FOSSA Status"><img src="https://app.fossa.com/api/projects/git%2Bgithub.com%2Fiotaledger%2Ffirefly.svg?type=shield"/></a>
6+
<a href="https://github.com/iotaledger/legacy-migration-tool/blob/main/LICENSE" style="text-decoration:none;"><img src="https://img.shields.io/badge/License-Apache%202.0-green.svg" alt="Apache 2.0 license"></a>
177
</p>
188

199
<p align="center">
@@ -27,19 +17,19 @@
2717

2818
## About
2919

30-
Firefly is IOTA's new official wallet for Chrysalis.
20+
Legacy Migration Tool is IOTA's tool to migrate funds from legacy to stardust protocol.
3121

3222
## Installation
3323

34-
There are a few options to install Firefly:
24+
There are a few options to install Legacy Migration Tool:
3525

36-
- Download from [official Firefly website](https://firefly.iota.org)
37-
- Build from source code (see [desktop README](https://github.com/iotaledger/firefly/blob/develop/packages/desktop/README.md))
26+
- Download from [official Legacy Migration Tool repository](https://github.com/iotaledger/legacy-migration-tool/releases)
27+
- Build from source code (see [desktop README](https://github.com/iotaledger/legacy-migration-tool/blob/main/packages/desktop/README.md))
3828

3929
## Contributing
4030

41-
Help out the Firefly project by filing a [bug report](https://github.com/iotaledger/firefly/issues/new?assignees=&labels=bug&template=bug_report.yml), making a [feature request](https://github.com/iotaledger/firefly/issues/new?assignees=&labels=feat&template=feature_request.md) or opening a [pull request](https://github.com/iotaledger/firefly/pulls/).
42-
See the [contribution guidelines](https://github.com/iotaledger/firefly/blob/develop/.github/CONTRIBUTING.md) for more.
31+
Help out the Legacy Migration Tool project by filing a [bug report](https://github.com/iotaledger/legacy-migration-tool/issues/new?assignees=&labels=bug&template=bug_report.yml), making a [feature request](https://github.com/iotaledger/legacy-migration-tool/issues/new?assignees=&labels=feat&template=feature_request.md) or opening a [pull request](https://github.com/iotaledger/legacy-migration-tool/pulls/).
32+
See the [contribution guidelines](https://github.com/iotaledger/legacy-migration-tool/blob/main/.github/CONTRIBUTING.md) for more.
4333

4434
## Joining the discussion
4535

docs/glossary.md

Lines changed: 0 additions & 73 deletions
This file was deleted.

docs/guides/coding-conventions/comments.md

Lines changed: 0 additions & 70 deletions
This file was deleted.

0 commit comments

Comments
 (0)