Skip to content

Commit

Permalink
docs: edit formatting & link MFS to ProtoSchool (ipfs#499)
Browse files Browse the repository at this point in the history
- Change bullet formatting to make it possible to use the markdown headers to link specifically to the MFS portion of this document. 
- Link out from MFS section to the ProtoSchool tutorial as part of Q3 IPFS Docs initiative (see issue ProtoSchool/protoschool.github.io#260)
  • Loading branch information
terichadbourne authored and alanshaw committed Jul 17, 2019
1 parent 18f9a74 commit f8e5628
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions SPEC/FILES.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

> The files API enables users to use the File System abstraction of IPFS. There are two Files API, one at the top level, the original `add`, `cat`, `get` and `ls`, and another behind the [`files`, also known as MFS](https://github.com/ipfs/specs/issues/98). [We are currently going through a revamping process of these APIs to make them more user-friendly](https://github.com/ipfs/interface-ipfs-core/issues/284).
- The Regular (top level) API for add, cat, get and ls Files on IPFS
#### The Regular API
The regular, top-level API for add, cat, get and ls Files on IPFS
- [add](#add)
- [addFromFs](#addfromfs)
- [addFromStream](#addfromstream)
Expand All @@ -18,7 +19,11 @@
- [ls](#ls)
- [lsPullStream](#lspullstream)
- [lsReadableStream](#lsreadablestream)
- The Files API, aka MFS (Mutable File System)

#### The Files API
The Files API, aka MFS (Mutable File System)

_Explore the Mutable File System through interactive coding challenges in our [ProtoSchool tutorial](https://proto.school/#/mutable-file-system/)._
- [files.cp](#filescp)
- [files.flush](#filesflush)
- [files.ls](#filesls)
Expand Down

0 comments on commit f8e5628

Please sign in to comment.