Skip to content

Commit 9a5957e

Browse files
committed
Add docs and update README
1 parent e06ab79 commit 9a5957e

7 files changed

Lines changed: 73 additions & 9 deletions

File tree

.gitmodules

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[submodule "docs/.shared"]
2+
path = docs/.shared
3+
url = https://github.com/amphp/website-shared

README.md

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,28 @@
11
# windows-registry
22

3-
![Unstable](https://img.shields.io/badge/api-unstable-orange.svg?style=flat-square)
3+
![Stable](https://img.shields.io/badge/v0.3-stable-green.svg?style=flat-square)
44
![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)
55

6-
`amphp/windows-registry` provides asynchronous access to the Windows Registry based on the [`amp`](https://github.com/amphp/amp)
7-
concurrency framework.
6+
`amphp/windows-registry` provides asynchronous access to the Windows Registry for [Amp](https://github.com/amphp/amp).
87

9-
**Required PHP Version**
8+
## Installation
109

11-
- PHP 5.5+
10+
```bash
11+
composer require amphp/windows-registry
12+
```
1213

13-
**Installation**
14+
## Documentation
1415

15-
```bash
16-
$ composer require amphp/windows-registry
17-
```
16+
Documentation is bundled within this repository in the [`./docs`](./docs) directory.
17+
18+
## Versioning
19+
20+
`amphp/windows-registry` follows the [semver](http://semver.org/) semantic versioning specification like all other `amphp` packages.
21+
22+
## Security
23+
24+
If you discover any security related issues, please email [`me@kelunik.com`](mailto:me@kelunik.com) instead of using the issue tracker.
25+
26+
## License
27+
28+
The MIT License (MIT). Please see [`LICENSE`](./LICENSE) for more information.

docs/.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
.bundle
2+
_site
3+
vendor
4+
Gemfile.lock

docs/.shared

Submodule .shared added at abae56c

docs/Gemfile

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
source "https://rubygems.org"
2+
gem "github-pages"
3+
gem "kramdown"
4+
gem "jekyll-github-metadata"
5+
gem "jekyll-relative-links"

docs/_config.yml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
kramdown:
2+
input: GFM
3+
toc_levels: 2..3
4+
5+
baseurl: "/windows-registry"
6+
layouts_dir: ".shared/layout"
7+
8+
exclude: ["Gemfile", "Gemfile.lock", "README.md", "vendor"]
9+
include: [".shared"]
10+
11+
repository: amphp/windows-registry
12+
gems:
13+
- "jekyll-github-metadata"
14+
- "jekyll-relative-links"
15+
16+
defaults:
17+
- scope:
18+
path: ""
19+
type: "pages"
20+
values:
21+
layout: "docs"
22+
23+
asset_path: "/windows-registry/.shared/asset"

docs/index.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
title: Windows Registry
3+
permalink: /
4+
---
5+
`amphp/windows-registry` is a small helper package to ease reading the Windows registry. This might be necessary to access system settings such as the default DNS server.
6+
7+
## Installation
8+
9+
```
10+
composer require amphp/windows-registry
11+
```
12+
13+
## Usage
14+
15+
`WindowsRegistry` has the two methods `listKeys` and `read`.
16+
17+
`listKeys` fetches all sub-keys of one key. `read` reads the value of the key. Note that `read` doesn't convert any values and returns them as they're printed by `reg query %s`.

0 commit comments

Comments
 (0)