Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update README files for all of the Dart packages #1613

Merged
merged 3 commits into from
Dec 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions packages/dart/noports_core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,20 @@
[![GitHub License](https://img.shields.io/badge/license-BSD3-blue.svg)](./LICENSE)
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/atsign-foundation/noports/badge)](https://api.securityscorecards.dev/projects/github.com/atsign-foundation/noports)

# No Ports Core
# NoPorts Core

No Ports Core is the underlying library used to enable sshnoports and the rest of the No Ports suite.
NoPorts Core is the shared library used to enable the rest of the NoPorts suite.
This contains the heart of the NoPorts implementation.

## Examples

### CLI Example

See the [sshnoports](https://github.com/atsign-foundation/noports/tree/trunk/packages/dart/sshnoports) project.
See the [sshnoports](../sshnoports/README.md) project.

### Flutter Example

See the [sshnp_flutter](https://github.com/atsign-foundation/noports/tree/trunk/packages/dart/sshnp_flutter) project.
See the [npt_flutter](../npt_flutter/README.md) project.

## Maintainers

Expand Down
23 changes: 14 additions & 9 deletions packages/dart/npt_flutter/README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,21 @@
# npt_flutter
<a href="https://atsign.com#gh-light-mode-only"><img width=250px src="https://atsign.com/wp-content/uploads/2022/05/atsign-logo-horizontal-color2022.svg#gh-light-mode-only" alt="The Atsign Foundation"></a><a href="https://atsign.com#gh-dark-mode-only"><img width=250px src="https://atsign.com/wp-content/uploads/2023/08/atsign-logo-horizontal-reverse2022-Color.svg#gh-dark-mode-only" alt="The Atsign Foundation"></a>

A new Flutter project.
# NoPorts Desktop

This is the source code for the NoPorts Desktop application.
See [the website](https://noports.com) for more information, or its companion
[documentation site](https://docs.noports.com) for technical and usage
information.

## Getting Started

This project is a starting point for a Flutter application.
## Building From Source

A few resources to get you started if this is your first Flutter project:
Building from source is possible and will work with already activated atSigns.
However, without a valid API key, activating newly registered atSigns is not
possible. You can circumvent this by either:

- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
- Downloading the app from the store
- Use the [at_activate binary](../sshnoports/README.md) to activate first, then
load the generated .atkeys file into the app.

For help getting started with Flutter development, view the
[online documentation](https://docs.flutter.dev/), which offers tutorials,
samples, guidance on mobile development, and a full API reference.
11 changes: 5 additions & 6 deletions packages/dart/sshnoports/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,12 @@
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/atsign-foundation/noports/badge)](https://api.securityscorecards.dev/projects/github.com/atsign-foundation/noports)
[![SLSA 3](https://slsa.dev/images/gh-badge-level3.svg)](https://slsa.dev)

# SSH! No ports
# NoPorts CLI Binaries

ssh no ports provides a way to ssh to a remote linux host/device without that
device or the client having any open ports (not even 22) on external interfaces. All
network connectivity is out bound and there is no need to know the IP
address the device has been given. As long as the device and client has an IP address (public or private 1918),
DNS and Internet access, you will be able to connect to it.
This is the source code for the NoPorts Command Line Interface (CLI) binaries.
See [the website](https://noports.com) for more information, or its companion
[documentation site](https://docs.noports.com) for technical and usage
information.

## Quick demo
![sshnp](https://github.com/atsign-foundation/noports/assets/6131216/4ff005f1-230e-4621-9b33-f834caa9a1d1)
Expand Down
15 changes: 14 additions & 1 deletion packages/dart/sshnp_flutter/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,16 @@
# sshnp_flutter

A new Flutter project
SSH NoPorts desktop is our original UI for NoPorts, which predates NoPorts'
support for using NoPorts over any TCP tunnel. NoPorts originally only supported
SSH in its earlier releases.

> **We don't recommend using this application anymore.**
> It is no longer maintained.
> The choice to use this application is at your own risk.

If you want a good UI experience, we recommend
[NoPorts desktop (a.k.a. the npt_flutter directory)](../npt_flutter/README.md).

If you want a better SSH experience, we recommend
[this guide](https://docs.noports.com/usage/integrate-with-ssh-config).

Loading