Skip to content

Commit

Permalink
docs(README): sync API
Browse files Browse the repository at this point in the history
  • Loading branch information
Create or Update Pull Request Action authored and arlac77 committed Apr 23, 2021
1 parent ff56429 commit a981230
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[![minified size](https://badgen.net/bundlephobia/min/svn-simple-auth-provider)](https://bundlephobia.com/result?p=svn-simple-auth-provider)
[![downloads](http://img.shields.io/npm/dm/svn-simple-auth-provider.svg?style=flat-square)](https://npmjs.org/package/svn-simple-auth-provider)
[![GitHub Issues](https://img.shields.io/github/issues/arlac77/svn-simple-auth-provider.svg?style=flat-square)](https://github.com/arlac77/svn-simple-auth-provider/issues)
[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Farlac77%2Fsvn-simple-auth-provider%2Fbadge&style=flat)](https://actions-badge.atrox.dev/arlac77/svn-simple-auth-provider/goto)
[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Farlac77%2Fsvn-simple-auth-provider%2Fbadge\&style=flat)](https://actions-badge.atrox.dev/arlac77/svn-simple-auth-provider/goto)
[![Styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
[![Known Vulnerabilities](https://snyk.io/test/github/arlac77/svn-simple-auth-provider/badge.svg)](https://snyk.io/test/github/arlac77/svn-simple-auth-provider)
Expand All @@ -19,20 +19,21 @@ provide credentials from subversion simple auth

### Table of Contents

- [SvnSimpleAuthProvider](#svnsimpleauthprovider)
- [Parameters](#parameters)
- [Properties](#properties)
* [SvnSimpleAuthProvider](#svnsimpleauthprovider)
* [Parameters](#parameters)
* [Properties](#properties)

## SvnSimpleAuthProvider

### Parameters

- `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** (optional, default `{}`)
- `options.realmDirectory` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** defaults to HOME/.subversion/auth/simple.auth
* `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** (optional, default `{}`)

* `options.realmDirectory` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** defaults to HOME/.subversion/auth/simple.auth

### Properties

- `realmDirectory` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
* `realmDirectory` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**

# install

Expand Down

0 comments on commit a981230

Please sign in to comment.