Skip to content

Commit abcb88e

Browse files
🪴 LICENSE file updated
1 parent 5927222 commit abcb88e

File tree

16 files changed

+263
-246
lines changed

16 files changed

+263
-246
lines changed

CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66

77
- Addition of Plugin Support,
88
- #67 error handling infinite loop issue
9-
- Breaking changes: Enums PublishType changed to snake-case to CAPITAL
10-
- Basic improvements
9+
- Breaking change: Enums PublishType changed from snake-case to ALL_CAPS
10+
- Basic Improvements
1111

1212
## v1.10.2
1313

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2012 - 2022 Contentstack
3+
Copyright (c) 2012 - 2023 Contentstack
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
1-
[![Contentstack](https://www.contentstack.com/docs/static/images/contentstack.png)](https://www.contentstack.com/)
1+
# [![Contentstack](https://www.contentstack.com/docs/static/images/contentstack.png)](https://www.contentstack.com/)
22

33
## Java SDK for Contentstack
44

55
Contentstack is a headless CMS with an API-first approach. It is a CMS that developers can use to build powerful cross-platform applications in their favorite languages. Build your application frontend, and Contentstack will take care of the rest. [Read More](https://www.contentstack.com/).
66

77
Contentstack provides Java SDK to build application on top of Java. Given below is the detailed guide and helpful resources to get started with our Java SDK.
88

9-
109
### Prerequisite
1110

1211
You will need JDK installed on your machine. You can install it from [here](http://www.oracle.com/technetwork/java/javase/downloads/jdk9-downloads-3848520.html).
@@ -15,13 +14,14 @@ You will need JDK installed on your machine. You can install it from [here](http
1514

1615
To use the Contentstack Java SDK to your existing project, perform the steps given below:
1716

18-
Group id: `com.contentstack.sdk`
17+
Group Id: ```com.contentstack.sdk```
18+
19+
Artifact Id: ```java```
1920

20-
Artifact id: `java`
21+
[LATEST VERSION](https://search.maven.org/artifact/com.contentstack.sdk/java)
2122

22-
[{ version }](https://search.maven.org/artifact/com.contentstack.sdk/java)
23+
#### Maven
2324

24-
1. **Maven**
2525
```java
2626
<dependency>
2727
<groupId>com.contentstack.sdk</groupId>
@@ -30,7 +30,8 @@ Artifact id: `java`
3030
</dependency>
3131
```
3232

33-
2. **Gradle**
33+
#### Gradle
34+
3435
```java
3536
implementation 'com.contentstack.sdk:java:{version}'
3637
```
@@ -59,19 +60,17 @@ Assets refer to all the media files (images, videos, PDFs, audio files, and so o
5960

6061
A publishing environment corresponds to one or more deployment servers or a content delivery destination where the entries need to be published. Learn how to work with [Environments](https://www.contentstack.com/docs/guide/environments).
6162

62-
63-
6463
### Contentstack Java SDK: 5-minute Quickstart
6564

6665
#### Initializing your SDK
6766

6867
To initialize the SDK, specify application API key, access token, and environment name of the stack as shown in the snippet given below:
68+
6969
```java
7070
Stack stack=Contentstack.stack("apiKey","accessToken","environment");
7171
```
72-
To get the API credentials mentioned above, log in to your Contentstack account and then in your top panel navigation, go to Settings &gt; Stack to view the API Key and Access Token.
73-
7472

73+
To get the API credentials mentioned above, log in to your Contentstack account and then in your top panel navigation, go to Settings &gt; Stack to view the API Key and Access Token.
7574

7675
#### Querying content from your stack
7776

@@ -101,7 +100,7 @@ To retrieve multiple entries of a particular content type, use the code snippet
101100
Query query = stack.contentType("content_type_uid").query();
102101
query.find(new QueryResultsCallBack(){
103102
@Override
104-
public void onCompletion(ResponseType responseType, QueryResult queryResult, Error error) {
103+
public void onCompletion(ResponseType responseType, QueryResult queryResult, Error error) {
105104
if(error == null){
106105
//Success block
107106
}else{
@@ -110,7 +109,6 @@ query.find(new QueryResultsCallBack(){
110109
});
111110
```
112111

113-
114112
### Advanced Queries
115113

116114
You can query for content types, entries, assets and more using our Java API Reference.
@@ -121,7 +119,7 @@ You can query for content types, entries, assets and more using our Java API Ref
121119

122120
We have introduced Image Delivery APIs that let you retrieve images and then manipulate and optimize them for your digital properties. It lets you perform a host of other actions such as crop, trim, resize, rotate, overlay, and so on.
123121

124-
For example, if you want to crop an image (with width as 300 and height as 400), you simply need to append query parameters at the end of the image URL, such as, https://images.contentstack.io/v3/assets/download?crop=300,400. There are several more parameters that you can use for your images.
122+
For example, if you want to crop an image (with width as 300 and height as 400), you simply need to append query parameters at the end of the image URL, such as, <https://images.contentstack.io/v3/assets/download?crop=300>,400. There are several more parameters that you can use for your images.
125123

126124
[Read Image Delivery API documentation](https://www.contentstack.com/docs/apis/image-delivery-api/).
127125

0 commit comments

Comments
 (0)