Skip to content

Commit 68cd16c

Browse files
committed
Standarize Readme and add License
See ipfs/community#124
1 parent 94c8744 commit 68cd16c

File tree

2 files changed

+44
-4
lines changed

2 files changed

+44
-4
lines changed

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2014 Juan Batiz-Benet
3+
Copyright (c) 2016 Protocol Labs, Inc.
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 43 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,34 @@
11
# fs-repo-migrations
22

3+
[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)
4+
[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)
5+
[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
6+
[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
7+
8+
> Migrations for the filesystem repository of ipfs clients
9+
310
These are migrations for the filesystem repository of [ipfs](https://github.com/ipfs/ipfs) clients. This tool is written in Go, and developed alongside [go-ipfs](https://github.com/ipfs/go-ipfs), but it should work with any repo conforming to the [fs-repo specs](https://github.com/ipfs/specs/tree/master/repo/fs-repo).
411

5-
## When should I migrate
12+
## Table of Contents
13+
14+
- [Install](#install)
15+
- [Usage](#usage)
16+
- [When should I migrate](#when-should-i-migrate)
17+
- [How to Run Migrations](#how-to-run-migrations)
18+
- [Developing Migrations](#developing-migrations)
19+
- [Contribute](#contribute)
20+
- [Want to hack on IPFS?](#want-to-hack-on-ipfs)
21+
- [License](#license)
22+
23+
## Install
24+
25+
```sh
26+
make install
27+
```
28+
29+
## Usage
30+
31+
### When should I migrate
632

733
When you want to upgrade go-ipfs to a new version, you may need to
834
migrate.
@@ -16,15 +42,29 @@ ipfs repo version | go-ipfs versions
1642
2 | 0.3.0 - 0.3.11
1743
3 | 0.4.0 - current
1844

19-
## How to Run Migrations
45+
### How to Run Migrations
2046

2147
Please see the [migration run guide here](run.md).
2248

23-
## Developing Migrations
49+
### Developing Migrations
2450

2551
Migrations are one of those things that can be extremely painful on users. At the end of the day, we want users never to have to think about it. The process should be:
2652

2753
- SAFE. No data lost. Ever.
2854
- Revertible. Tools must implement forward and backward migrations.
2955
- Frozen. After the tool is written, all code must be frozen and vendored.
3056
- To Spec. The tools must conform to the spec.
57+
58+
## Contribute
59+
60+
Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/fs-repo-migrations/issues)!
61+
62+
This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
63+
64+
### Want to hack on IPFS?
65+
66+
[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/contributing.md)
67+
68+
## License
69+
70+
MIT

0 commit comments

Comments
 (0)