doc: update README.md

master
Harshavardhana 8 years ago
parent d0636d633d
commit cbb6b48b94
  1. 14
      README.md

@ -1,7 +1,9 @@
# Minio Quickstart Guide # Minio Quickstart Guide [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/minio/minio?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
Minio is an object storage server released under Apache License v2.0. It is compatible with Amazon S3 cloud storage service. It is best suited for storing unstructured data such as photos, videos, log files, backups and container / VM images. Size of an object can range from a few KBs to a maximum of 5TB. Minio is an object storage server released under Apache License v2.0. It is compatible with Amazon S3 cloud storage service. It is best suited for storing unstructured data such as photos, videos, log files, backups and container / VM images. Size of an object can range from a few KBs to a maximum of 5TB.
## 1. Download ## 1. Download
Minio server is light enough to be bundled with the application stack, similar to NodeJS, Redis and MySQL. Minio server is light enough to be bundled with the application stack, similar to NodeJS, Redis and MySQL.
| Platform| Architecture | URL| | Platform| Architecture | URL|
@ -14,8 +16,6 @@ Minio server is light enough to be bundled with the application stack, similar t
||32-bit|https://dl.minio.io/server/minio/release/windows-386/minio.exe| ||32-bit|https://dl.minio.io/server/minio/release/windows-386/minio.exe|
|FreeBSD|64-bit|https://dl.minio.io/server/minio/release/freebsd-amd64/minio| |FreeBSD|64-bit|https://dl.minio.io/server/minio/release/freebsd-amd64/minio|
### Install from Source ### Install from Source
Source installation is only intended for developers and advanced users. If you do not have a working Golang environment, please follow [How to install Golang](https://docs.minio.io/docs/how-to-install-golang). Source installation is only intended for developers and advanced users. If you do not have a working Golang environment, please follow [How to install Golang](https://docs.minio.io/docs/how-to-install-golang).
@ -25,7 +25,8 @@ $ go get -d github.com/minio/minio
$ cd $GOPATH/src/github.com/minio/minio $ cd $GOPATH/src/github.com/minio/minio
$ make $ make
``` ```
## 2. Run Minio Server
## 2. Run Minio Server
### 1. GNU/Linux ### 1. GNU/Linux
@ -140,7 +141,6 @@ Open a web browser and navigate to http://127.0.0.1:9000 to view your buckets on
![Screenshot](./Minio_Browser.png) ![Screenshot](./Minio_Browser.png)
## 4. Test Minio Server using `mc` ## 4. Test Minio Server using `mc`
Install mc from [here](https://docs.minio.io/docs/minio-client-quick-start-guide). Use `mc ls` command to list all the buckets on your minio server. Install mc from [here](https://docs.minio.io/docs/minio-client-quick-start-guide). Use `mc ls` command to list all the buckets on your minio server.
@ -156,7 +156,9 @@ $ mc ls myminio/
For more examples please navigate to [Minio Client Complete Guide](https://docs.minio.io/docs/minio-client-complete-guide). For more examples please navigate to [Minio Client Complete Guide](https://docs.minio.io/docs/minio-client-complete-guide).
## 5. Explore Further ## 5. Explore Further
- [Minio Erasure Code QuickStart Guide](https://docs.minio.io/docs/minio-erasure-code-quickstart-guide) - [Minio Erasure Code QuickStart Guide](https://docs.minio.io/docs/minio-erasure-code-quickstart-guide)
- [Minio Docker Quickstart Guide](https://docs.minio.io/docs/minio-docker-container) - [Minio Docker Quickstart Guide](https://docs.minio.io/docs/minio-docker-container)
- [Use `mc` with Minio Server](https://docs.minio.io/docs/minio-client-quick-start-guide) - [Use `mc` with Minio Server](https://docs.minio.io/docs/minio-client-quick-start-guide)
@ -167,5 +169,3 @@ For more examples please navigate to [Minio Client Complete Guide](https://docs.
## 6. Contribute to Minio Project ## 6. Contribute to Minio Project
Please follow Minio [Contributor's Guide](./CONTRIBUTING.md) Please follow Minio [Contributor's Guide](./CONTRIBUTING.md)

Loading…
Cancel
Save