Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
dzikoysk committed Aug 30, 2017
1 parent 0715922 commit 89f00a2
Show file tree
Hide file tree
Showing 2 changed files with 83 additions and 1 deletion.
76 changes: 75 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,77 @@
# NanoMaven [![Build Status](https://travis-ci.org/dzikoysk/NanoMaven.svg?branch=master)](https://travis-ci.org/dzikoysk/NanoMaven)

Lightweight repository manager for Maven artifacts

#### Download
Releases: [GitHub Downloads](https://github.com/dzikoysk/NanoMaven/releases)

Required: Java 1.8

#### Features
* [x] Working repository manager
* [x] Multiple repositories under a single URL
* [x] Deploy
* [x] Authorization
* [ ] Proxy for the specified remote repositories
* [ ] Front page
* [ ] Statistics

#### Configuration
```yaml
# ~~~~~~~~~~~~~~~~~~~~~~ #
# Nano Maven #
# ~~~~~~~~~~~~~~~~~~~~~~ #

# General Repository Name
repository-name: NanoMaven Repository

# Hostname
hostname: ''
# Port
port: 80

# Include a repository names in the path
repository-path-enabled: false
# Enable directory indexing
indexing-enabled: true

# Nested Maven
nested-maven: true
# External Maven directory (if 'nested-maven': false)
external-maven: /usr/local/share/java/maven33

# Accept deployment connections
deploy-enabled: true
# Require authorization
authorization-enabled: true
# Administrator accounts
administrators:
- dzikoysk
```
#### Commands
Commands can be invoked from the console
```bash
NanoMaven 1.0.3 Commands:
help - List available commands
add-user <username> <password> - Add user
add-project <groupId|artifactId> - Add project extra data
add-member <groupId|artifactId> <username> - Add user to the specified project
reinstall-artifacts (rs) - Reinstall all artifacts
```
#### Maven builds
You can also use maven to embed NanoMaven in your application
```xml
<dependency>
<groupId>org.panda-lang</groupId>
<artifactId>nanomaven</artifactId>
<version>1.0.3</version>
</dependency>

<repository>
<name>Panda Repository</name>
<id>panda-repository</id>
<url>https://repo.panda-lang.org/</url>
</repository>
```
8 changes: 8 additions & 0 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -121,11 +121,19 @@

<repositories>
<repository>
<name>Panda Repository</name>
<id>panda-repo</id>
<url>https://repo.panda-lang.org/</url>
</repository>
</repositories>

<distributionManagement>
<repository>
<id>panda-repository</id>
<url>https://repo.panda-lang.org</url>
</repository>
</distributionManagement>

<build>
<defaultGoal>clean install</defaultGoal>
<plugins>
Expand Down

0 comments on commit 89f00a2

Please sign in to comment.