Skip to content

Commit dc3ed86

Browse files
committed
update readme and package.json
1 parent 933f4c8 commit dc3ed86

File tree

2 files changed

+16
-5
lines changed

2 files changed

+16
-5
lines changed

README.md

+9-4
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,18 @@
11
# git-opensource
22

3-
Before opensourcing, it is common practice in (larger) companies to erase all git history of a projects repository. This ensures that no proprietary information or IP remains anywhere in the commits which could cause serious legal issues or security vulnerabilities. However, this practice also contradicts one of the core fundamentals of opensource culture: __Give credit where credit is due.__
3+
Before opensourcing, it is common practice in (larger) companies to erase all history from a projects git repository. This ensures that no proprietary information or IP remains anywhere in the commits which could cause legal issues or security vulnerabilities. However, this practice also contradicts one of the core fundamentals of opensource culture: __Give credit where credit is due.__
44

5-
`git-opensource` is a small utility trying to solve this problem. It rewrittes the current branch to a new target-branch, __erasing all content from the commit history while preserving information about contributors and their statistics__.
5+
`git-opensource` is a small utility trying to solve this problem. It rewrites the current branch to a new target-branch, __erasing all content from the commit history while preserving information about contributors and their statistics__.
66

77
## Installation
88

9-
TBD
10-
9+
```bash
10+
$ npm install -g git-opensource
11+
```
12+
or
13+
```
14+
curl ...
15+
```
1116
## Usage
1217
```bash
1318
# prepare

package.json

+7-1
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,14 @@
33
"version": "0.0.1",
44
"author": {
55
"name": "Philipp Adrian",
6-
"email": "[email protected]"
6+
"email": "[email protected]",
7+
"url": "http://philippadrian.com"
78
},
9+
"repository": {
10+
"type": "git",
11+
"url": "https://github.com/greenish/git-opensource"
12+
},
13+
"license": "MIT",
814
"bin": {
915
"git-opensource": "git-opensource.sh"
1016
}

0 commit comments

Comments
 (0)