Skip to content

Commit 6736c35

Browse files
author
Harsh Shandilya
committed
Rewrite README
Signed-off-by: Harsh Shandilya <harsh@prjkt.io>
1 parent fd96cde commit 6736c35

2 files changed

Lines changed: 38 additions & 33 deletions

File tree

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Transfer [ ![Codeship Status for dev-harsh1998/Transfer](https://app.codeship.com/projects/6cfba370-60d1-0136-95b6-3296b091a39e/status?branch=master)](https://app.codeship.com/projects/296378)
2+
3+
Transfer is a command line utility built as a wrapper around cURL for one purpose - Uploading files to [transfer.sh](https://transfer.sh). It abstracts away all the manual cURL syntax to make usage effortless.
4+
5+
## How to use?
6+
7+
```
8+
$ transfer myfile.file
9+
https://transfer.sh/t9a5Q/myfile.file
10+
```
11+
12+
## Installation
13+
You can simply install transfer by following these instructions, make sure you have `git` and `curl` installed.
14+
15+
```
16+
# Clone the repository.
17+
git clone https://github.com/dev-harsh1998/Transfer
18+
# Navigate to cloned directory.
19+
cd Transfer
20+
# Compile latest binary on your own machine!!.
21+
make transfer
22+
# Install it for direct access.
23+
sudo make install
24+
```
25+
26+
Additionally you can supply parameters to change the compiler and optimisation level, like `CC=clang OPT_LEVEL=-O3 make transfer`
27+
28+
29+
BOOM! Easy right? There you are done you have successfully built and installed transfer on your machine.
30+
31+
## Supported Platforms
32+
- Linux x86
33+
- Linux x86_64
34+
- macOS
35+
36+
## Issue or feature request?
37+
38+
Please write about issues and feature request [here](https://github.com/dev-harsh1998/Transfer/issues).

Readme.md

Lines changed: 0 additions & 33 deletions
This file was deleted.

0 commit comments

Comments
 (0)