~ricardokirkner/click-toolbelt/fix-storeapi-upload-missing-config : contents of README at revision 54

~ricardokirkner/click-toolbelt/fix-storeapi-upload-missing-config : (revision 54)

5 by Ricardo Kirkner expanded the README file with details about the normal use case	1	==============
1 by Ricardo Kirkner initial import of click-toolbelt repository	2	Click Toolbelt
	3	==============
	4
11.2.6 by Ricardo Kirkner updated README with documentation for the register and info commands	5	Available commands
	6	==================
5 by Ricardo Kirkner expanded the README file with details about the normal use case	7
	8	Login
	9	-----
	10
	11	Uploading a click package requires the developer to submit
11.2.3 by Ricardo Kirkner added documentation for register command	12	an oauth signed request. For this, click-toolbelt needs to first
5.1.1 by Michael Nelson small tweaks	13	obtain an oauth token. In order to do so, the user can run the
	14	following (note: be sure to prepend the command with a space so that
	15	your command history doesn't save the sensitive command).
5 by Ricardo Kirkner expanded the README file with details about the normal use case	16
	17	::
	18
7.1.1 by Ricardo Kirkner renamed click namespace to click_toolbelt to avoid colliding with existing click package	19	$ click-toolbelt login <email> <password> [otp]
5 by Ricardo Kirkner expanded the README file with details about the normal use case	20
	21
	22	On successful execution this command will store the oauth credentials
11.2.3 by Ricardo Kirkner added documentation for register command	23	in ``$HOME/.config/click-toolbelt/click.cfg`` and will use it during the
5 by Ricardo Kirkner expanded the README file with details about the normal use case	24	upload step.
	25
	26
	27	Upload
	28	------
	29
	30	Once the user is successfully logged in, he can then upload
33.1.1 by Ricardo Kirkner fix documentation still referring to old register command	31	the click package. In order to do so, the user can run
5 by Ricardo Kirkner expanded the README file with details about the normal use case	32
	33	::
	34
33.1.1 by Ricardo Kirkner fix documentation still referring to old register command	35	$ click-toolbelt upload <binary_file> [--metadata <metadata_file>]
21.1.1 by Ricardo Kirkner prepare new release	36
	37
	38	For this command to be successful, certain criteria must be met:
	39
	40	- user must be logged in already (see `Login`_)
	41	- the binary file must be a valid click package
33.1.1 by Ricardo Kirkner fix documentation still referring to old register command	42	- user owns the application for which he's uploading the click package (if the application already exists)
21.1.1 by Ricardo Kirkner prepare new release	43
	44	The ``metadata_file`` parameter should refer to a file containing a json document. If this file is provided,
	45	it will be used to extract extra information not provided in the click package's manifest.
	46
33.1.1 by Ricardo Kirkner fix documentation still referring to old register command	47	When uploading the initial package, the following fields might be extracted from the ``metadata_file``:
11.2.3 by Ricardo Kirkner added documentation for register command	48
	49	- tagline: A one line summary for the app
	50	- department: The app's category name (see `Department`_)
34.3.1 by Matias Bordese Updated channel info.	51	- channel: The upload target channel name (see `Channel`_). If omitted, 'stable' is assumed.
11.2.3 by Ricardo Kirkner added documentation for register command	52	- support_url: A URL users can go to for support for this application. Allows http(s): and mailto: schemes
	53	- license: The license under which the app will be released (see `License`_)
11.2.7 by Ricardo Kirkner submit icon and screenshot files properly alonside the metadata	54	- icon_256 (or icon): The path to a local file to be uploaded as the icon for the application; the icon must be 256x256 px in size
11.2.3 by Ricardo Kirkner added documentation for register command	55	- name: Application name (overrides what's defined in the click package manifest)
	56	- description: Application description (overrides what's defined in the click package manifest)
11.2.7 by Ricardo Kirkner submit icon and screenshot files properly alonside the metadata	57	- changelog: A description of the changes included since the last upload
	58	- screenshots: A list of paths to local files to be uploaded as screenshots for the application
11.2.6 by Ricardo Kirkner updated README with documentation for the register and info commands	59	- blacklist_ids: A list of country codes to prevent the application from being distributed to (see `Country`_)
	60	- whitelist_ids: A list of country codes to limit the application being distributed to (see `Country`_)
11.2.3 by Ricardo Kirkner added documentation for register command	61	- auto_publish: Automatically submit for review
	62	- reviewer_notes: Notes for reviewers to use when reviewing the app's submission
	63
33.1.1 by Ricardo Kirkner fix documentation still referring to old register command	64	For a new version upload, the ``metadata_file`` file will only be scanned for the following fields:
	65
34.3.1 by Matias Bordese Updated channel info.	66	- channel: The upload target channel name (see `Channel`_). If omitted, 'stable' is assumed.
33.1.1 by Ricardo Kirkner fix documentation still referring to old register command	67	- changelog: A description of the changes included since the last upload
	68
	69
11.2.3 by Ricardo Kirkner added documentation for register command	70	.. _`Developer Portal`: https://developer.ubuntu.com/
	71
	72
11.2.6 by Ricardo Kirkner updated README with documentation for the register and info commands	73	Info
	74	----
	75
	76	The ``info`` command will return metadata about the current available API. To retrieve this data, the user
	77	can run the following command::
	78
	79	$ click-toolbelt info
	80
11.3.1 by Ricardo Kirkner expand info command to allow fetching a subset of the data	81	This will show all available information about the API. Alternative, the user can retrieve only a subset of the data.
	82
	83	Get the current API version
	84	::
	85
	86	$ click-toolbelt info version
	87
	88
	89	Get the list of valid license values
	90	::
	91
	92	$ click-toolbelt info license
	93
	94
	95	Get the list of valid countries
	96	::
	97
	98	$ click-toolbelt info country
	99
	100
34.3.1 by Matias Bordese Updated channel info.	101	Get the list of valid channels
	102	::
	103
	104	$ click-toolbelt info channel
	105
	106
11.3.1 by Ricardo Kirkner expand info command to allow fetching a subset of the data	107	Get the list of valid departments
	108	::
	109
	110
	111	$ click-toolbelt info department
11.2.6 by Ricardo Kirkner updated README with documentation for the register and info commands	112
	113
	114	Data values
	115	===========
	116
11.2.3 by Ricardo Kirkner added documentation for register command	117	Department
	118	----------
	119
11.2.6 by Ricardo Kirkner updated README with documentation for the register and info commands	120	Valid values can be obtained via the ``info`` command (or it's equivalent api call).
	121
	122	Examples
	123	........
11.2.3 by Ricardo Kirkner added documentation for register command	124
	125	- "Accessories"
	126	- "Games"
	127	- "Card Games"
11.2.6 by Ricardo Kirkner updated README with documentation for the register and info commands	128
11.2.3 by Ricardo Kirkner added documentation for register command	129
	130	License
	131	-------
	132
11.2.6 by Ricardo Kirkner updated README with documentation for the register and info commands	133	Valid values can be obtained via the ``info`` command (or it's equivalent api call).
	134
	135	Examples
	136	........
11.2.3 by Ricardo Kirkner added documentation for register command	137
	138	- "Proprietary"
11.2.6 by Ricardo Kirkner updated README with documentation for the register and info commands	139	- "GNU GPL v3"
11.2.3 by Ricardo Kirkner added documentation for register command	140	- "BSD License (Simplified)"
11.2.6 by Ricardo Kirkner updated README with documentation for the register and info commands	141
	142
	143	Country
	144	-------
	145
	146	Valid values can be obtained via the ``info`` command (or it's equivalent api call).
	147
	148	.. note:
	149
	150	The ``info`` command will return a list of tuples: (country_code, country_name). The values to be supplied
	151	in the ``metadata_file`` are only the country codes.
	152
	153	Examples
11.2.3 by Ricardo Kirkner added documentation for register command	154	........
	155
	156	- "AR" (Argentina)
	157	- "BR" (Brazil)
	158	- "GB" (United Kingdom)
	159	- "US" (United States)
	160	- "UY" (Uruguay)
34.3.1 by Matias Bordese Updated channel info.	161
	162
	163	Channel
	164	-------
	165
	166	Valid values can be obtained via the ``info`` command (or it's equivalent api call).
	167
	168	Examples
	169	........
	170
	171	- "stable"
	172	- "proposed"
	173	- "alpha"