Browse Source

udpate the docs some

main
John-Mark Gurney 4 years ago
parent
commit
2b92fa1b4a
1 changed files with 11 additions and 10 deletions
  1. +11
    -10
      README.md

+ 11
- 10
README.md View File

@@ -7,10 +7,10 @@ up simple code as a Python package, you can import it directly via
the hash.

There is the concept of aliases to make the import statements easier
to read. This is currently limited to packages. An example is the
randpkg in the fixtures directory. You can put a file named
cas_aliases.txt along side your __init__.py file. Each line of the
file is:
to read. An alias file is currently limited to python packages (modules
in a directory w/ an __init__.py file). An example is the randpkg in
the fixtures directory. You can put a file named cas_aliases.txt along
side the __init__.py file. Each line of the file is:
```
<alias> <url>
```
@@ -21,13 +21,13 @@ at. Currently, at least one hash url must be specified.
The following url schemes are supported:
<dl>
<dt>hash</dt>
<dd>At least one of these MUST be specified. This is specified at
[hash-uri](https://github.com/hash-uri/hash-uri) and currently only
<dd>At least one of these MUST be specified. The url format is specified
by [hash-uri](https://github.com/hash-uri/hash-uri) and currently only
a hash value of sha256 is supported.</dd>
<dt>ipfs</dt>
<dd>The format follows the
<dd>The format follows ipfs scheme url as specified by the
[IPFS Addressing](https://github.com/ipfs/in-web-browsers/blob/master/ADDRESSING.md)
document, and it is recommend that CIDv1 addresses are used, as the
document. It is recommend that CIDv1 addresses are used, as the
host portion of a URL is case insensitive, and CIDv0 (the current
default) values are case sensitive. An example is:
`ipfs://bafkreibtbcckul7lwxqz7nyzj3dknhwrdxj5o4jc6gsroxxjhzz46albym`.</dd>
@@ -59,8 +59,9 @@ Configuration
-------------

By default, a configuration file is read from `~/.casimport/casimport.conf`.
This specifies the priority of the different modules (do you search IPFS or
HTTPS urls first), and configures each of the modules.
The configuration file allows the specification of the priority of the
different modules (does casimport search IPFS or HTTPS urls first), and
the configuration each of the modules.

The first time you import casimport, a sample configuration will be created.
The default is a local cache the home directory, and then to use IPFS


Loading…
Cancel
Save