Skip to content

Commit

Permalink
updated the readme to make it more suitable for pub.dev.
Browse files Browse the repository at this point in the history
  • Loading branch information
bsutton committed Aug 23, 2022
1 parent bc08b45 commit 52719ab
Showing 1 changed file with 30 additions and 9 deletions.
39 changes: 30 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,16 @@
# OnePub

The offical support site for OnePub the hosted private package repository for Dart and Flutter.
OnePub is a hosted (SAAS) private package repository for Dart and Flutter.

OnePub is to Dart what NPM is to JavaScript and JFrog to Java.
> OnePub is to Dart what NPM is to Javascript
OnePub aims to provide the same experience as pub.dev but for your own private packages only shared within your team.

* A private repository for your Dart and Flutter packages.
* Painless IDE and CLI Integration.
* Watch public and private packages and receive update notices.
* Hosted API documentation for your private packages
* Search both pub.dev and your private packages from one search page.

OnePub lets you use the existing Dart tooling (dart pub publish | flutter pub publish) to publish packages to your own private repository.

Expand All @@ -15,7 +23,7 @@ Full documentation is available at:

https://docs.onepub.dev

## Installing
# Installing
To install onepub run:

```bash
Expand All @@ -24,11 +32,29 @@ onepub login
```
The `onepub login` command will register you with OnePub.

# opub
# Publish
To publish a private package to OnePub

```bash
cd <my first project>
onepub pub private
dart pub publish
```

# Add a private dependeny

To add a dependency on a private package to your project

```bash
cd <my second project>
onepub pub add <my first project>
```

# opub
With Google deprecating the pub command in favour of using `flutter pub` or `dart pub`
we have created a replacement `opub` command for the lazy ones amoungst us (like me).

You will also need to use opub to publish to OnePub if you are using a version of Dart pre 2.12.

Our opub command is a very thin wrapper for `flutter pub` and `dart pub` and simply
passes any command line arguments through to `flutter pub` or `dart pub`.
Expand Down Expand Up @@ -56,8 +82,3 @@ any other pub subcommands and arguments
```

Enjoy.


# Security Policy
Details on our [Security Policy](https://github.com/onepub-dev/onepub/blob/master/SECURITY.md)

0 comments on commit 52719ab

Please sign in to comment.