README: Reformat the document

parent 117e4b33
# [Oh My Fish][oh-my-fish] official package repository
Primary package repository for the [Oh My Fish][oh-my-fish] [Fish shell][fish] framework.
This repository contains a list of public Fish packages that can be installed by name using Oh My Fish. The goal of this repo is to maintain a discoverable index of quality Fish packages that can easily be maintained by the Fish community.
## Repository format
Packages are referenced in the repository using property files located in the `packages/` directory. The actual code of each package is stored in separate, individual Git repositories maintained by the package maintainer themselves. This keeps control of the package in the owner's hands, but still allows easy sharing of the package.
The name of each property file indicates the package name, and the various properties in the file describe the package and how it can be installed. These are the properties currently used:
......@@ -14,6 +16,7 @@ The name of each property file indicates the package name, and the various prope
- `description`: A short description of the package.
## Submitting a package
Want to add your own package to the public repository? First, make a fork of this Git repository. Then create a package description file inside the `packages/` directory. The file name should be the name of your package without any file extensions, and should contain at least these properties:
```
......@@ -29,7 +32,6 @@ Once you've created and committed your package description file, [open a pull re
Once your pull request is merged, your package will be immediately available for all users to install!
[fish]: http://fishshell.com
[new-pr]: https://github.com/oh-my-fish/packages-main/pull/new/master
[oh-my-fish]: https://github.com/oh-my-fish/oh-my-fish
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment