Skip to content

Commit e0cd74b

Browse files
committed
Add some text to README.
1 parent 6f97893 commit e0cd74b

File tree

3 files changed

+28
-26
lines changed

3 files changed

+28
-26
lines changed

LICENSE

-21
This file was deleted.

README.md

+26-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1-
AlephClient
1+
alephclient
22
===========
33

4-
API client for Aleph API.
4+
Command-line client for Aleph 2. It can be used to bulk import document sets via
5+
the API, without direct access to the server. It requires an active API client
6+
to perform uploads.
57

68

79
Installation
@@ -39,4 +41,25 @@ alephclient --api-base-url http://127.0.0.1:5000/api/2/ --api-key 2c0ae66024f040
3941

4042
License
4143
=======
42-
MIT
44+
45+
MIT License
46+
47+
Copyright (c) 2018 Journalism Development Network, Inc.
48+
49+
Permission is hereby granted, free of charge, to any person obtaining a copy
50+
of this software and associated documentation files (the "Software"), to deal
51+
in the Software without restriction, including without limitation the rights
52+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
53+
copies of the Software, and to permit persons to whom the Software is
54+
furnished to do so, subject to the following conditions:
55+
56+
The above copyright notice and this permission notice shall be included in all
57+
copies or substantial portions of the Software.
58+
59+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
60+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
61+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
62+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
63+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
64+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
65+
SOFTWARE.

setup.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
setup(
44
name='alephclient',
55
version='0.1',
6-
description="API client for Aleph API",
6+
description="Command-line client for Aleph API",
77
author='Journalism Development Network',
88
author_email='[email protected]',
99
url='http://github.com/alephdata/alephclient',
@@ -28,6 +28,6 @@
2828
},
2929
entry_points='''
3030
[console_scripts]
31-
alephclient=alephclient.cli:cli
31+
alephclient = alephclient.cli:cli
3232
''',
3333
)

0 commit comments

Comments
 (0)